Add the Addon Development manual under docs/addon-development#994
Merged
GaryGriffin merged 1 commit intoJul 24, 2026
Merged
Conversation
eduralph
force-pushed
the
docs/addon-dev-manual
branch
from
July 20, 2026 00:26
7ddcdb6 to
a79d2cb
Compare
Seventeen manual pages for addon authors - overview and getting started, tutorials per addon kind, the addon-kinds catalogue, registration fundamentals, data access, API reference, testing, debugging, troubleshooting, code analysis, internationalization, packaging, post-merge community steps, compatibility, per-release changes, normative guidelines, and roadmap - plus the diagrams they embed and a folder index. The new docs/ tree is invisible to make.py and CI: every enumeration keys on *.gpr.py or *.py globs that match nothing under docs/, verified with manifest-check and a no-op 'build docs' run.
eduralph
force-pushed
the
docs/addon-dev-manual
branch
from
July 20, 2026 00:49
a79d2cb to
fc38d4d
Compare
eduralph
marked this pull request as ready for review
July 20, 2026 00:52
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
2 participants
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.
User impact: Addon authors get a complete, in-repo, GitHub-rendered development manual — from first Gramplet to packaging, community steps, and cross-version porting — instead of having only the aging wiki page to work from.
Summary
Adds
docs/addon-development/— a 17-page Addon Development manual plus embedded diagrams and a folder index. The pages cover: overview & getting started, tutorials per addon kind, the addon-kinds catalogue, registration fundamentals, data access, the curated API surface, testing, debugging, troubleshooting, code analysis, internationalization, packaging, post-merge community steps, compatibility, per-release changes, a normative MUST/SHOULD/MAY rules page, and a roadmap.This PR adds new files only; no existing file is touched. A follow-up PR wires
README.mdandCONTRIBUTING.mdto the manual.What to look at
docs/addon-development/README.mdand01-overview.md— the index and the section map; the reading order and jump table are the manual's front door.16-guidelines.md— the normative rules page (RFC-2119 style) that the rest of the manual cites; rules carry their origin (PR, maintainer ruling, Mantis id) inline.Verification
docs/is invisible tomake.pyand CI: every enumeration keys on*.gpr.py/*.pyglobs that match nothing here. Checked:python3 make.py gramps60 manifest-checkpasses andpython3 make.py gramps60 build docsproduces no tarball; the CIis_active()filter (.github/scripts/active_addons.sh) returns inactive for a directory without a.gpr.py.