Installation docs...
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 90/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Look at the existing installation documentation in the project's docs directory, likely under 'getting-started' or 'installation'. The issue suggests updating the instructions to mention both pip and uv, and to provide a clear, neutral example. Check the mkdocs documentation for the current installation steps and revise them to include the suggested commands: 'python3 -m venv venv', 'venv/bin/pip install mkdocs', and 'venv/bin/mkdocs', while also linking to uv's documentation. Ensure the changes are made in the correct markdown files and verify by building the docs locally.
Written by the indexing model from the issue text.
Description
pip and uv
I suppose let's be staightforward when we can, and link out to step-by-step walk throughs for new comers when needed.
Most of what I'm seeing these days recommends uv and they've got good little docs to point towards.
If we're doc'ing pip then python3 -m venv venv ... venv/bin/pip install mkdocs ... venv/bin/mkdocs is a dependable route.
We might want to use slightly neutral "Install the mkdocs python package..." then the console example.
- Dominant language
- Python
- Stars
- 32
- Forks
- 2
- Avg merge
- 8h 51m
- Merged PRs (30d)
- 15
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from encode/mkdocs
-
Licensing Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Reminders... Open
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
stephrobert/dsoxlab#238 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
sublimehq/package_control#1780 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
nwg-piotr/nwg-displays#145 ·