Skip to content

Repository navigation

docs: add Installation guide link to README #62

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.

Sign up for GitHub

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

Merged
lovelydinosaur merged 2 commits into from
Oct 7, 2026
Merged

docs: add Installation guide link to README #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
702f837
docs: add Installation guide link to README
AllAboutDocs Oct 1, 2026
793a610
chore: remove accidentally committed .DS_Store
AllAboutDocs Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
venv/
dist/
site/
.DS_Store

@lovelydinosaur lovelydinosaur Oct 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is specific to your operating system, so it's a little neater to keep this in global gitignore.

2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To install MkDocs, run the following command from the command line:
pip install mkdocs --pre
```

This will install the version 2.0 pre-release.
This will install the version 2.0 pre-release. For full installation steps, including using uv and troubleshooting common issues, see the [Installation Guide](INSTALLATION.md).

## Getting started

Expand Down
Loading