mirror of
https://github.com/astral-sh/uv.git
synced 2025-07-07 21:35:00 +00:00
Add page for contributing to the docs (#4562)
This commit is contained in:
parent
cb580d1a5d
commit
f7fb5a4061
1 changed files with 21 additions and 0 deletions
21
docs/README.md
Normal file
21
docs/README.md
Normal 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`.
|
Loading…
Add table
Add a link
Reference in a new issue