docs: add Installation guide link to README - #62
Open
AllAboutDocs wants to merge 2 commits into
Open
AllAboutDocs wants to merge 2 commits into
AllAboutDocs wants to merge 2 commits into
Conversation
lovelydinosaur
requested changes
Oct 1, 2026
lovelydinosaur
left a comment
lovelydinosaur
left a comment
Member
There was a problem hiding this comment.
Neat, thanks!
Also a good prompt to get the mkdocs check tooling in place.
Looks like there's a binary that's been accidentally committed.
Collaborator
Author
|
Fixed - removed the accidentally committed .DS_Store and confirmed it's already covered by .gitignore, so it shouldn't happen again. Ready for another look whenever you have a chance! |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a link to the Installation Guide (
INSTALLATION.md) from the## Installationsection on the docs homepage (docs/README.md).Why
The homepage's Installation section only shows the quick
pip install mkdocs --precommand, with no pointer to the full guide added in #60 (uv install path, prerequisites, troubleshooting). This links the two together so a first-time user lands on the complete instructions.Testing
Ran
mkdocs servelocally and confirmed:/installation/page.