Repository navigation
Keep docs/ to the architecture, agent resources and user guide - #122
Open
MatthiasHertelArm wants to merge 2 commits into
Open
MatthiasHertelArm wants to merge 2 commits into
MatthiasHertelArm wants to merge 2 commits into
Conversation
Working material leaves docs/: the proposals, the reviews, the field report, the improvement notes, the user stories, the historical feature inventory and the September codebase review with its verification. They were records of how the extension came about, not a description of it, and they remain in the history. docs/ keeps the architecture pages, the documents served to agents, the user guide, the packaging note, the README images and the TPIP inputs. The architecture pages, the historical acceptance checklist and a source comment no longer link to the removed notes.
docs/provenance/ held the behaviour specifications and the per-file results of the independent rewrite (Open-CMSIS-Pack#53). It is evidence for the licence review (Open-CMSIS-Pack#54), not a description of the extension, and it remains in the history. AGENTS.md, CHANGES-VS-UPSTREAM.md, the CHANGELOG entry of the rewrite, two architecture pages and the transport harness no longer link to it; the known-bug numbers stay in the code comments.
MatthiasHertelArm
marked this pull request as ready for review
November 4, 2026 09:58
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.
Fixes
Changes
docs/keeps what describes the extension: the architecture pages, the documents served to agents (docs/agent-resources/), the user guide, the packaging note, the README images and the TPIP inputs.docs/proposals/(33 files),docs/reviews/,docs/field-reports/,docs/improvement-notes.md,docs/user-stories.md,docs/DebugMCP-brief-feature-inventory.md, anddocs/codebase-review-2026-09.mdwith its verification.docs/provenance/, the behaviour specifications and per-file results of the independent rewrite (Rewrite the remaining MS-derived core to fully own the codebase (drop MIT lineage) #53). Theprovenance:checkgate andsrc/test/provenance.test.tsstay; the known-bug numbers stay in the code comments.AGENTS.md,CHANGES-VS-UPSTREAM.md, the CHANGELOG entry of the rewrite, four architecture pages, the historical acceptance checklist, the transport harness README and two code comments..vscodeignoreships onlydocs/agent-resources/), so the package does not change.Checked locally:
npm run lint:md,npm run check-types,npm run provenance:check -- --gate(passed, 197 gated files), and a relative-link check over every tracked Markdown file (0 broken).Screenshots
None; no UI change.
Checklist