Skip to content

docs: ADR index and template; bring stale decision records up to date - #608

Open
WilliamKarolDiCioccio wants to merge 1 commit into
mainfrom
chore/adr-housekeeping
Open

WilliamKarolDiCioccio wants to merge 1 commit into
mainfrom
chore/adr-housekeeping

Conversation

@WilliamKarolDiCioccio

Copy link
Copy Markdown
Collaborator

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)
    • When an ADR is warranted: it binds forks, the backend, deployers or IdP operators; it sets a contributor-wide rule; it has security impact; or the topic has been rewritten or argued about more than once.
    • An index of ADR-001 to ADR-003. It also points out that the "Riverpod is DI only" rule lives in ADR-001 §5.3.
    • The status vocabulary: Proposed, Accepted, Superseded and Deprecated. An ADR moves to Accepted in the PR that implements it.
    • Amend or supersede: a narrow change gets a dated Amended by note, and a reversal gets a new ADR.
    • A template that follows the shape the existing ADRs already use.
  • ADR-003
  • docs/plans/0001-app-shell/proposal.md: a "partly superseded" note. ModuleContribution / "no base class" was replaced by AppModule (feat(core): AppModule lifecycle replaces ModuleContribution #172), and flavor functions by Flavor (ADR-003).
  • docs/developer-setup.md: removes the GIT_LFS_SKIP_SMUDGE step. ag_ui has 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 lists docs/adr/, the flavor authoring guide, the diagnostics risk register and the schema-snapshot procedure. The shell proposal is labelled historical.

Not in this PR

Test plan

  • markdownlint-cli2 passes on every touched file.
  • Relative links from the proposal to ADR-001 and ADR-003 resolve.
  • pubspec.lock resolves ag_ui as source: hosted, and no pubspec has a git: dependency.

🤖 Generated with Claude Code

…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant