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

docs: fix links to index page #155

Merged
merged 1 commit into from
Oct 29, 2024
Merged

docs: fix links to index page #155

merged 1 commit into from
Oct 29, 2024

Conversation

mlegner
Copy link
Collaborator

@mlegner mlegner commented Oct 29, 2024

mdBook should replace links to README.md by links to index.html. However, in practice, it doesn't do that.

By naming the file index.md, this is solved at the minor downside of not quite as nice rendering on GitHub.

@mlegner mlegner added bug Something isn't working documentation Improvements or additions to documentation labels Oct 29, 2024
@mlegner mlegner enabled auto-merge (squash) October 29, 2024 13:22
Copy link
Contributor

github-actions bot commented Oct 29, 2024

PR Preview Action v1.4.8
Preview removed because the pull request was closed.
2024-10-29 14:00 UTC

@mlegner mlegner merged commit bc34bba into main Oct 29, 2024
8 checks passed
@mlegner mlegner deleted the ml/fix-index-links branch October 29, 2024 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants