docs: adopt documentation-driven development system#117
Merged
Conversation
Introduce DOCUMENTATION.md and RFC/ADR/Spec/Plan/Review skeleton adapted from DesignPatterns. Migrate ADR-001, expand AGENTS.md doc workflow and agent conduct rules, add architecture and contributor guides, and pilot Events Spec/Design split.
Skymly
commented
Jul 8, 2026
Skymly
left a comment
Skymly
left a comment
Owner
Author
There was a problem hiding this comment.
CI is green on run 28952223048 (all domain test/pack jobs + doc-loc parity passed; NuGet consumer smoke skipped as expected for a docs-only PR).
Good bootstrap of the documentation-driven workflow:
docs/DOCUMENTATION.mdis a clear authority for doc types, OBS segments, and tri-repo sync — and correctly omits a root CHANGELOG (ROADMAP C3).- ADR migration from
docs/design/decisions/0001-*toADR-001-*with a redirect README keeps history discoverable. - Events Spec/Design split is a sensible pilot; the trimmed
docs/design/events.mdpoints to the normative spec without duplicating contract text. AGENTS.md/CONTRIBUTING.md/ PR template checklist align agent and human contributors on when to add Spec vs Design vs ADR.
Follow-up items in the plan look right: RestAPI + SignalR spec splits and E5 diagnostic Fix/examples in Observables.Docs. No blockers from my side.
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
1 participant
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.
Summary
docs/DOCUMENTATION.mdand the RFC/ADR/Spec/Plan/Review directory skeleton (adapted from DesignPatterns; no root CHANGELOG per ROADMAP C3).docs/adr/ADR-001-primitives-backend-skip.md.AGENTS.mdwith documentation workflow and agent conduct rules; updateCONTRIBUTING.mdand PR template Documentation checklist.docs/design/architecture.md,docs/design/contributor.md(ROADMAP E11).docs/spec/Events.md+ trimmeddocs/design/events.md.Closes #116
Test plan
docs/README.mdand cross-referencesFollow-up (tracked in plan)