Skip to content

Fix: API doc runs on local dev #631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Conversation

Stu-conduktor
Copy link
Contributor

@Stu-conduktor Stu-conduktor commented Feb 11, 2025

Today API docs don't work locally so can't test properly, have to push & pray.
If you change the path to work locally, it breaks on production.

This dynamically updates the path so it works on prod and local for testing.

Tested on Vercel preview and it solved the problem, in addition to local.

image

Copy link

vercel bot commented Feb 11, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
conduktor-docs ✅ Ready (Inspect) Visit Preview Apr 1, 2025 7:15pm

@Stu-conduktor Stu-conduktor changed the title Fix: Work local dev Fix: API doc runs on local dev Feb 11, 2025
@RG-conduktor
Copy link
Collaborator

@Stu-conduktor are you still working on this one?

@Stu-conduktor
Copy link
Contributor Author

Stu-conduktor commented Apr 1, 2025

I think it's still useful, allows you to test locally the API reference site. Today it doesn't work:
image

I believe this fix is good as it works on the Vercel preview too. My only caution is to validate on prod once merged and check it works, its slightly riskier than the typical PR.

We can do together at some point and revert if it breaks.

It would also be good to validate the API ref page behaviour doesn't change with this and links etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants