docs(python): make the PyPI description a short readable introduction - #905
Merged
Merged
Conversation
The README PyPI renders as the opensysml project description was the full developer document, with paragraphs that ran for forty lines. Keep the install, quickstart and documentation links, and replace the dense service-resolution section with a short ordered list and a pointer to the service guide. Co-Authored-By: jason.han <hanhuijun@gmail.com>
Contributor
Author
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Merged
6 tasks done
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What and why
The README that PyPI renders as the
opensysmlproject description reads badly: the 0.9.1 page on https://pypi.org/project/opensysml/ is the old 460-line developer document, with a forty-line paragraph ofEditor.add_*detail and long dense passages about the trust model. The README ondevelophad already been cut down to a quickstart (#1a0d20e2d), but its "Service resolution" section was still one twenty-line block of prose.This replaces that section with a plain description of what the client does on first connection, the four-step binary lookup as an ordered list, one sentence on download verification, how to point at a service you run yourself, and a link to the service guide for the rest. The detail it drops is already in
docs/clients/python/service.md.The PyPI page itself only changes when the next release is published, since the description is taken from the README in the released sdist/wheel.
How it was verified
python -m build --sdistfromclient/pythonandpython -m twine check --strictpass.python -m readme_renderer client/python/README.mdrenders cleanly (what PyPI uses).python3 scripts/check-doc-links.py: 0 broken links.python3 scripts/changelog.py checkpasses.Checklist
make testandmake lintpass locally (docs-only change; no Go or Python code touched)changes/unreleased/<slug>.<section>.md, not as an edit toCHANGELOG.mdmake docs-countsrun if a gate count moved (not applicable)F4,K5) in the body, docs, or changelogLink to Devin session: https://nasa-jpl-demo.devinenterprise.com/sessions/e56e09be1de344e0a914ad59a2176c7b
Open in Devin Desktop: https://nasa-jpl-demo.devinenterprise.com/desktop/session/e56e09be1de344e0a914ad59a2176c7b?variant=devin
Requested by: @HuiJun