Doc: Restructure contribution docs into the Canonical contribution model#940
Open
akcano wants to merge 3 commits into
Open
Doc: Restructure contribution docs into the Canonical contribution model#940akcano wants to merge 3 commits into
akcano wants to merge 3 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures Workshop’s contribution documentation into a Canonical-style contribution model by splitting the previous single contributing guide into focused pages (development, documentation, maintenance) and updating navigation and references across the docs and repo guidance.
Changes:
- Replaces the monolithic
docs/contributing.rstcontent with a high-level entry point plus a hidden toctree to new contribution sub-guides. - Adds new contribution guides for development, documentation, and maintenance, and wires them into the docs home page.
- Updates repository guidance to point at the new locations (PR template, Copilot instructions, and the code-review agent prompt), plus a spelling wordlist update.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/index.rst | Updates site navigation and “Get involved” links to the new contribution docs structure. |
| docs/contributing/maintenance.rst | Adds a maintainer-focused guide (release process, CI/CD, doc tooling). |
| docs/contributing/documentation.rst | Adds a documentation contribution guide (setup, write, test, review). |
| docs/contributing/development.rst | Adds a development contribution guide (setup, test, review workflow). |
| docs/contributing.rst | Replaces the prior long-form guide with a concise landing page and toctree to the new guides. |
| docs/coding-style-guide.md | Updates references so style guidance no longer depends on removed contributing content. |
| docs/.custom_wordlist.txt | Adds “subshell” to the project wordlist for docs/spell checks. |
| .github/pull_request_template.md | Updates the template link to point at the coding style guide for error-message guidance. |
| .github/copilot-instructions.md | Updates pointers from the old contributing guide to the coding style guide / new contribution docs. |
| .github/agents/code-review.agent.md | Updates the agent’s referenced inputs to include the new contribution docs. |
akcano
force-pushed
the
docs/contributing
branch
from
July 15, 2026 17:41
1efc4cd to
f69a0d2
Compare
akcano
marked this pull request as ready for review
July 16, 2026 22:44
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
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.
No description provided.