Skip to content
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

Include /reference/ path on local builds #724

Closed
LikeTheSalad opened this issue Mar 12, 2025 · 1 comment · Fixed by #956
Closed

Include /reference/ path on local builds #724

LikeTheSalad opened this issue Mar 12, 2025 · 1 comment · Fixed by #956
Assignees
Labels
build relates to invocation of the tool(s) enhancement

Comments

@LikeTheSalad
Copy link

I was checking the guide to contribute docs locally, and when I ran docs-builder serve I got no errors, but I couldn't see the docs by opening http://localhost:3000/ (I was getting 404 errors). Luckily after taking a look at some messages in some Slack groups I came across this other link: http://localhost:3000/reference/ which did the trick 👍 and I was thinking that we should update the guide to include the /reference/ path in this part to avoid confusions in the future.

An alternative solution mentioned here might be to show the full link in the console.

@reakaleek
Copy link
Member

When #956 is released the CLI will redirect to the first page it finds if there is no root index.md file when running docs-builder serve.
In case of reference repos this means it will redirect to https://localhost:3000/reference

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build relates to invocation of the tool(s) enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants