docs: improve project documentation for a clearer public surface - #634
Draft
jatinkrmalik wants to merge 5 commits into
Draft
docs: improve project documentation for a clearer public surface#634jatinkrmalik wants to merge 5 commits into
jatinkrmalik wants to merge 5 commits into
Conversation
Rewrite the README and supporting docs for a more professional first impression: less emoji and badge noise, install-first structure, and a real documentation index. Add a Contributor Covenant, tighten SECURITY and GitHub templates, and make distro/update guides read as product docs instead of internal status notes.
github-actions
Bot
added
documentation
Break INSTALL.md into a short primary guide, manual/PyPI package lists, and troubleshooting. Add root CHANGELOG.md and SUPPORT.md, wire them into the docs index and README, and drop the outdated screenshot lag note now that v0.15 assets are on main.
Separate the contrib.rocks avatars from the contribute how-to links so the people who built the project are easier to spot.
Strip em/en dashes from the documentation rewritten in this PR, fix mid-sentence colon fallout from that pass, and smooth a few stiff phrases so the public docs read more natural.
The contrib.rocks image already links to the GitHub contributors page.
1 task
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.
Summary
Docs-only work so the repo front door is clearer and easier to trust: install paths, support, changelog, and contributor credit without badge soup or a full release dump in the README.
Main changes
docs/INSTALL.md, package lists indocs/INSTALL_MANUAL.md, failures indocs/TROUBLESHOOTING.mdCHANGELOG.mdandSUPPORT.mdat the repo rootCopy pass
Full humanizer pass on the PR markdown: no em/en dashes in the rewritten docs, fewer stiff mid-sentence colons, plainer list definitions.
Out of scope
Flathub marketing push, website copy audit, broader business/ops work.
Test plan
docs/README.mdlists the user-facing docsinstall.sh(--auto,--tag, engines)Note
Low Risk
Markdown and template changes only; no runtime or security-sensitive code paths are modified.
Overview
Docs-only refresh of the repo front door: clearer install/support paths, less README noise, and contributor-facing policies without changing application code.
The README is trimmed to a single badge row, install-first layout, a short v0.15 pointer (full notes live in
docs/UPDATE.md), a documentation table, privacy/security bullets, and a dedicated Contributors section. Long release tables, emoji-heavy sections, and the sidebar UI lag disclaimer are removed.Install and support are split for skimmability: lean
docs/INSTALL.md, package/PyPI detail in newdocs/INSTALL_MANUAL.md, and runtime failures in newdocs/TROUBLESHOOTING.md. RootCHANGELOG.mdandSUPPORT.mdcentralize release pointers and help channels.docs/README.mdindexes the doc set.Contributor and community docs gain
CODE_OF_CONDUCT.md(Contributor Covenant), a shorterCONTRIBUTING.md(mypy/make format, releases viadocs/RELEASE_PROCESS.md), calmer GitHub issue/PR templates, and tightenedSECURITY.md.docs/UPDATE.mdleads with upgrade steps and defers older versions to GitHub Releases;docs/DISTRO_COMPATIBILITY.mddrops the internal phase diary.Install examples across changed markdown now prefer download-then-run (
curl … -o /tmp/vl.sh+bash /tmp/vl.sh) instead of piping straight to bash. Copy is generally plainer (fewer em dashes and stiff colons).docs/RELEASE_PROCESS.mdtells maintainers to keep README release blurbs short and to updateCHANGELOG.mdon bump.Reviewed by Cursor Bugbot for commit 1ce4d84. Bugbot is set up for automated code reviews on this repo. Configure here.