mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-07-07 21:35:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add page for contributing to the docs (#4562)

Browse source
This commit is contained in:
Zanie Blue 2024-06-27 08:27:58 -04:00 • committed by GitHub
parent cb580d1a5d
commit f7fb5a4061
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 21 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/README.md Normal file
View file

@ -0,0 +1,21 @@
# Documentation
This is the home of the new documentation for uv.
The documentation is a work in progress and not ready for external references.
## Contributing
Install mdbook:
```
cargo install mdbook
```
To run the documentation locally:
```
mdbook watch docs --open
```
The documentation is published to GitHub Pages on merge to `main`.