rye
rye copied to clipboard
Adding docs
I know this is still experimental, but IMO an experiment is only as good as the data it can garner. IME I've noticed a lot of people use a user guide of some form. A lot of the README's contents could be refined into a user guide.
I really like what ruff and hatch have for documentation https://github.com/mitsuhiko/rye/compare/main...cnpryer:rye:docs.
To get the ball rolling on this one I’m thinking:
- Where/how install
- Overview of features
- Get Python with Rye
- Start a project with Rye
- Adding and removing deps
- Sync Rye’s current environment
- Installing a global tool
- Managing Rye Link to submit issue
Could be ~5min getting started
https://cnpryer.github.io/rye/user_guide/
I can submit this as a PR. I just used https://www.mkdocs.org/user-guide/deploying-your-docs/.