Improve releasing docs #850
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
|
Integration tests report: appsharing.space |
mfisher87
force-pushed
the
improve-release-docs
branch
from
53b5ae6 to
a9c830e
Compare
arjxn-py
reviewed
Aug 6, 2025
arjxn-py
approved these changes
Aug 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
@arjxn-py and I went through his first release together today and we identified areas for improving the docs. This PR implements those improvements!
The main problem is that the jupyter-releaser "my first release" docs are really heavy and detailed. If you want to release JupyterGIS you don't need to read most of that. This PR duplicates some info from those docs, but it's just the essentials, saving the releaser some time.
Checklist
Resolves #XXX.Failing lint checks can be resolved with:
pre-commit run --all-filesjlpm run lint📚 Documentation preview: https://jupytergis--850.org.readthedocs.build/en/850/
💡 JupyterLite preview: https://jupytergis--850.org.readthedocs.build/en/850/lite