Repository navigation
docs: ADR index and template; bring stale decision records up to date - #608
Open
WilliamKarolDiCioccio wants to merge 1 commit into
Open
WilliamKarolDiCioccio wants to merge 1 commit into
WilliamKarolDiCioccio wants to merge 1 commit into
Conversation
…date - docs/adr/README.md: when to write an ADR, an index, the status vocabulary, how to amend or supersede, and a template matching the existing records. - ADR-003: Accepted, since it shipped in #428 and #430. Its in-place "since superseded" note becomes a dated amendment by #536, and §4 no longer claims runSoliplexShell is unchanged. - The app-shell proposal is marked partly superseded: ModuleContribution gave way to AppModule (#172), and flavor functions to the Flavor object. - developer-setup: drop the GIT_LFS_SKIP_SMUDGE step. ag_ui has been a hosted package since d8dac7e, and CI no longer sets the variable. - AGENTS.md: list the ADRs and the docs it was missing. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.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.
Summary
This PR makes the ADRs we already have a reliable base for the ones still to come. It changes docs only.
docs/adr/README.md(new)Proposed,Accepted,SupersededandDeprecated. An ADR moves toAcceptedin the PR that implements it.Amended bynote, and a reversal gets a new ADR.ProposedtoAccepted. It shipped in refactor: reify the Flavor as a declaration object (ADR-003) #428 and refactor: build out the Flavor declaration object (ADR-003) #430.runSoliplexShell(ShellConfig)is unchanged.docs/plans/0001-app-shell/proposal.md: a "partly superseded" note.ModuleContribution/ "no base class" was replaced byAppModule(feat(core): AppModule lifecycle replaces ModuleContribution #172), and flavor functions byFlavor(ADR-003).docs/developer-setup.md: removes theGIT_LFS_SKIP_SMUDGEstep.ag_uihas been a hosted pub.dev package since d8dac7e, and no workflow sets the variable any more, so the doc's "CI sets this automatically" was also wrong.AGENTS.md: "Key Documentation" now listsdocs/adr/, the flavor authoring guide, the diagnostics risk register and the schema-snapshot procedure. The shell proposal is labelled historical.Not in this PR
_RoomScreenState: one State class owns six unrelated concerns #601).Test plan
markdownlint-cli2passes on every touched file.pubspec.lockresolvesag_uiassource: hosted, and no pubspec has agit:dependency.🤖 Generated with Claude Code