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

mkdocs serve starts with error page #35

Open
schlomo opened this issue Dec 10, 2024 · 1 comment
Open

mkdocs serve starts with error page #35

schlomo opened this issue Dec 10, 2024 · 1 comment

Comments

@schlomo
Copy link
Contributor

schlomo commented Dec 10, 2024

When I run make serve to browse the documentation the "start page" is actually an error page:
image

The reason is probably the lack of an index.md or maybe README.md in the docs subdirectory.

According to mkdocs/mkdocs#321 there is no simple way to avoid duplicating the readme info (otherwise this would have been a PR).

Goal: Meaningful infos on the "start page" of the docs

I'd also suggest to mention "proudly sponsored by Bonial" or something like that

@martinohmann
Copy link
Member

martinohmann commented Feb 4, 2025

mkdocs.yml is meant for configuring documentation generation in our internal backstage instance. We can add an index.md at one point which should get rid of the 404, but I don't see this as high priority at the moment.

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

No branches or pull requests

2 participants