ArchDoc Design record
ArchDoc

Index

Everything in the record, filterable by status. Read-only: documents change in git, not here.

Status

All 53 Accepted 41

Spec

How things work today, always current

12 View all
architecture Architecture commands Commands documents Documents export Export index Index layout Layout lifecycle Lifecycle links Links and the glossary lint Lint markdown Markdown relationships Relationships release Release

Proposals

RFC

Argued before it is built, frozen once decided

17 View all
RFC-0001 Guidance for coding agents Accepted RFC-0002 Renumbering a document Accepted RFC-0003 Refreshing generated files Accepted RFC-0004 Exporting the repository as JSON Accepted RFC-0005 Refreshing generated files raises the version pin Accepted RFC-0006 The export publishes what it parsed Accepted RFC-0007 The glossary is a type of its own Accepted RFC-0008 Questions are headings and resolved ones are kept Accepted RFC-0009 Changelog entries are structured data Accepted RFC-0010 The guides are published from a repository of their own Accepted RFC-0011 Groups name the documents that belong together Accepted RFC-0012 The rejection rationale is structured data Accepted RFC-0013 A ref can record an exchange Accepted RFC-0014 Lint rules and the command reference are published as data Accepted RFC-0015 Pull requests are checked against the branch they merge into Accepted RFC-0016 A release carries its documentation and an install script Accepted RFC-0018 The registry records every change since v0.5.1 Accepted

Decisions

ADR

One decision, and what it was decided against

24 View all
ADR-0001 Terminal documents are frozen Accepted ADR-0002 Identity is the filename number Accepted ADR-0003 Reverse relationships are derived Accepted ADR-0004 The front matter schema only gains optional keys Accepted ADR-0005 The dependency list is closed Accepted ADR-0006 Markdown is handled with the standard library Accepted ADR-0007 Masking never moves a byte Accepted ADR-0008 Whether a frozen document changed is decided by git Accepted ADR-0009 A lint error names something the user may change Accepted ADR-0010 Reference rules are monotonic Accepted ADR-0011 Only the command package imports cobra Accepted ADR-0012 The licence is AGPL-3.0-or-later Accepted ADR-0013 The specification is linted by the binary built from the same commit Accepted ADR-0014 The glossary does not count as implementation Accepted ADR-0015 The former repository names are never reused Accepted ADR-0016 The scaffolded workflow uses the published actions Accepted ADR-0017 The configuration is written at the repository root Accepted ADR-0018 The module path is the project's own domain Accepted ADR-0019 The export shape is held stable from 1.0 Accepted ADR-0020 Questions and the Changelog are published as structured data Accepted ADR-0021 The rejection rationale is published as structured data Accepted ADR-0022 The export schemas are identified by archdoc.dev URLs Accepted ADR-0023 Every finding no permitted edit can clear is a warning Accepted ADR-0024 Git is given every path as a name Accepted
Search this record

Titles, headings and prose as you type. Press enter for the full results, with filters.

↑↓ move All results and filters ↵