Skip to content

Docs fixes and updates #2060

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

Jump to bottom
Open
czerouni wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Docs fixes and updates #2060

czerouni wants to merge 11 commits into from

Conversation

@czerouni
Copy link

@czerouni czerouni commented Dec 31, 2025

I wanted to start helping with the documentation:

  • I ran copilot over the docs, asking it to fix typos and misspellings. I also modified the language in the pip page.
  • Added a definition for resetenv
  • Fixed the TODO link for the release_message
  • Fixed incorrect sample code in package_definition.rst
  • Added definitions for this.is_package and this.is_variant
  • Fixed some random formatting

@czerouni czerouni requested a review from a team as a code owner December 31, 2025 20:43
@czerouni
Docs fixes and updates
50b5061 
Signed-off-by: Craig Zerouni <czerouni@gmail.com>
JeanChristopheMorinPerso
JeanChristopheMorinPerso reviewed Jan 3, 2026
View reviewed changes
Copy link
Member

@JeanChristopheMorinPerso JeanChristopheMorinPerso left a comment

Choose a reason for hiding this comment

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

I think it looks good. I left some suggestions to fix the Sphinx format (wrong indentation, fix sphinx warnings, etc).

czerouni and others added 10 commits January 3, 2026 13:54
@czerouni @JeanChristopheMorinPerso
Update docs/source/caching.rst
56104aa 
Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: Craig Zerouni <czerouni@gmail.com>
@czerouni @JeanChristopheMorinPerso
Update docs/source/installation.rst
8b6f868 
Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: Craig Zerouni <czerouni@gmail.com>
@czerouni @JeanChristopheMorinPerso
Update docs/source/package_commands.rst
7ec6c47 
Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: Craig Zerouni <czerouni@gmail.com>
@czerouni @JeanChristopheMorinPerso
Update docs/source/package_commands.rst
007cdde 
Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: Craig Zerouni <czerouni@gmail.com>
@czerouni @JeanChristopheMorinPerso
Update docs/source/package_commands.rst
41b5444 
Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: Craig Zerouni <czerouni@gmail.com>
@czerouni @JeanChristopheMorinPerso
Update docs/source/package_definition.rst
35094d3 
Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: Craig Zerouni <czerouni@gmail.com>
@czerouni @JeanChristopheMorinPerso
Update docs/source/pip.rst
13ecb67 
Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: Craig Zerouni <czerouni@gmail.com>
@czerouni @JeanChristopheMorinPerso
Update docs/source/pip.rst
e48213e 
Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: Craig Zerouni <czerouni@gmail.com>
@czerouni @JeanChristopheMorinPerso
Update docs/source/pip.rst
3cb2f98 
Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: Craig Zerouni <czerouni@gmail.com>
@czerouni @JeanChristopheMorinPerso
Update docs/source/pip.rst
d5c19fb 
Co-authored-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
Signed-off-by: Craig Zerouni <czerouni@gmail.com>
@czerouni
Copy link
Author

czerouni commented Jan 3, 2026

All set - I accepted all those changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JeanChristopheMorinPerso JeanChristopheMorinPerso JeanChristopheMorinPerso left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@czerouni @JeanChristopheMorinPerso