docs: improve README and CONTRIBUTING for contributors#14985
Draft
skjnldsv wants to merge 2 commits into
Draft
Conversation
- README: restructure with Contributing, CoC, Getting help sections; slim contributing block to point to CONTRIBUTING.md; add Talk room link; drop GitHub Discussions (disabled); uv as primary build tool - CONTRIBUTING: add Code of Conduct section; uv as primary setup path, plain venv as fallback; update sphinx-autobuild install to use uv Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Replace all em dashes with colons or semicolons throughout README.rst and CONTRIBUTING.md. Add `--python 3.13` to uv venv commands with a note that older stable<N> branches may require a different version. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
Contributor
📖 Documentation PreviewNo RST documentation pages changed in this PR. Last updated: Thu, 21 May 2026 07:45:35 GMT |
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.
☑️ Resolves
Improves the contributor onboarding experience of the repository.
Summary
README.rstCONTRIBUTING.mdfor details)uvas primary tool, plain venv as fallbackpipenvinstructions.. _CC BY 3.0:referenceghcr.io/nextcloud/documentation/sphinx-latex:latestCONTRIBUTING.mduvas primary setup path, plain venv as alternativesphinx-autobuildinstall usesuv pip🖼️ Screenshots
N/A — text/documentation changes only.
✅ Checklist
codespellor similar and addressed any spelling issues