Point README and CONTRIBUTING at the in-repo addon manual#995
Merged
GaryGriffin merged 1 commit intoJul 24, 2026
Merged
Conversation
README: the develop-your-own-addon pointer now leads to the in-repo docs/addon-development manual first, with CONTRIBUTING.md for the contributor workflow and the wiki page as an alternative rendering. The dead Travis badge is dropped. CONTRIBUTING: the deep technical sections that the manual now covers - addon kinds, registration and GENERAL plugins, prerequisites, addon configuration, localization, distribution contents, report categories, and the wiki listing/documentation templates - are reduced to a short retained summary plus a link into the manual, each under its original heading so existing deep links keep resolving. The contributor-workflow content that is unique to this document - repository and fork setup, development branches, the addon checklist, the pull-request walkthrough, and the maintenance guidance - is kept in place unchanged. Also repairs pre-existing broken links: seven table-of-contents and overview anchors that never matched their headings, two (#https://...) hrefs, the garbled Addon-list-legend link, and the Localization snippet that had lost its underscore binding. Depends on the PR that adds docs/addon-development.
eduralph
marked this pull request as ready for review
July 20, 2026 00:53
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.
User impact: README and CONTRIBUTING now lead addon authors to the in-repo Addon Development manual, so the deep technical reference and the contributor workflow stop drifting apart — while every workflow section contributors wrote (fork setup, dev branches, the addon checklist, the PR walkthrough) stays in place, in their own words.
Depends on: the PR that adds
docs/addon-development/(the manual import). This PR only rewires the two entry documents onto it; reviewing it with that one merged (or checked out) makes the links live.Summary
docs/addon-development/README.mdfirst, with CONTRIBUTING.md named for the workflow and the wiki page kept as an alternative rendering. The dead Travis badge is dropped. Nothing else changes..gpr.pyregistration + GENERAL plugins, prerequisites, configuration, localization, distribution contents, report categories, the wiki listing/documentation templates) are reduced to a short retained summary plus a link into the manual — each under its original heading, so existing deep links and the ToC keep resolving. The unique workflow content is untouched: GitHub/fork setup, the three-repo dev environment, development branches, Review the Addon Checklist, the whole Create a Pull Request walkthrough, bug-tracker support, maintenance guidance, and "Addons External to Github".What to look at
#setup-a-github-accountvs "Set Up a Github Account"), two(#https://...)hrefs, the garbledAddon list legend]]]link, and the Localization snippet that had lost its_in_ = glocale.get_addon_translator(...).Verification
#anchorin CONTRIBUTING.md now resolves to a heading (checked mechanically with a GitHub-slug generator; zero missing, previously seven).docs/addon-development/...link and#anchorin both files resolves against the manual tree from the dependency PR (checked mechanically).