docs: update development instructions#1825
Merged
pedrolamas merged 7 commits intoMay 1, 2026
Merged
Conversation
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
pedrolamas
added
the
Docs - Enhancement
Contributor
There was a problem hiding this comment.
Pull request overview
Updates developer-facing documentation to better onboard human contributors by adding an architecture overview to the docs site and rewriting CONTRIBUTING guidance to be more explicit about workflow, commits, and quality checks.
Changes:
- Added a high-level architecture/structure overview to the development guide (stack, repo layout, key patterns).
- Reworked
CONTRIBUTING.mdwith clearer pre-reqs, branching/PR expectations, commit rules (conventional + DCO), and local/CI checks. - Minor docs-site wording tweak for Python setup section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/docs/development.md | Adds architecture overview and clarifies local docs build steps. |
| CONTRIBUTING.md | Rewrites contributor guidance (branching, commits, quality checks, translations, CLAUDE.md note). |
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
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.
Update the development related user documentation.
Resolves #1821