ArchDoc Design record
ArchDoc

Proposals

Proposals for how an area should work, argued before it is built. A decided proposal is frozen: later thinking arrives as a new document, never as an edit.

Accepted

17 · frozen

RFC-0001 Guidance for coding agents Updated by RFC-0010 A set of guides that tell a coding agent how to work in a specification repository, written into the repository on request, refreshed by a command, and packaged... RFC-0002 Renumbering a document Updated by RFC-0011 A command that changes a numbered document's identifier and follows every reference to it, refusing wherever a frozen document would be left pointing at a file... RFC-0003 Refreshing generated files Updated by RFC-0005 A command that regenerates the files ArchDoc writes and a repository then keeps, shows what would change, and asks before writing. It leaves the version the wor... RFC-0004 Exporting the repository as JSON Updated by RFC-0006, RFC-0007, RFC-0008, RFC-0009, RFC-0011, RFC-0012, RFC-0013 A command that writes every document, its parsed sections, its resolved links and the relationships ArchDoc derives, as JSON conforming to a published schema, s... RFC-0005 Refreshing generated files raises the version pin archdoc update raises the workflow's ARCHDOC_VERSION to the version doing the update, holding the existing pin only when the running binary is not a published r... RFC-0006 The export publishes what it parsed Updated by RFC-0007, RFC-0008, RFC-0009, RFC-0011, RFC-0012 archdoc export replaces its sections object with contents, a flat ordered array of every heading and the prose beneath it. Links gain a type, the envelope gains... RFC-0007 The glossary is a type of its own The glossary stops being a spec page. Each term becomes one file under term/, GLOSSARY.md is generated at the repository root beside INDEX.md, and the export ca... RFC-0008 Questions are headings and resolved ones are kept Updated by RFC-0009, RFC-0010, RFC-0011, RFC-0012, RFC-0013 Open questions becomes an optional section that holds each open question as a level three heading, with any detail as prose beneath it. An optional Resolved que... RFC-0009 Changelog entries are structured data Updated by RFC-0012 Changelog becomes an optional section whose entries are read as data: each entry is a list item beginning - , optionally dated YYYY-MM-DD:, and holds the lines... RFC-0010 The guides are published from a repository of their own The guides packaged as skills move out of this repository into archdochq/skills, which the release workflow writes from each stable release, with the manifests... RFC-0011 Groups name the documents that belong together A group is a document of a new type, group/<slug>.md, whose front matter lists the RFCs, ADRs, refs and spec pages that belong to it and whose body describes wh... RFC-0012 The rejection rationale is structured data Every level two section titled Rejection rationale is published in the export as rejection_rationale, each with its heading's anchor and line and its prose as w... RFC-0013 A ref can record an exchange A ref gains an optional as_of date, which marks it as a record of an exchange that took place on that date. L13 does not report a ref carrying it, L07 checks it... RFC-0014 Lint rules and the command reference are published as data Updated by RFC-0018 Each lint rule in the registry gains a title, a summary, a remedy, the release that introduced it and the releases that changed it, as data. A hidden command, a... RFC-0015 Pull requests are checked against the branch they merge into archdoc lint --merge checks a pull request, as checked out merged into the configured branch, under four rules of its own: no draft lands, a document arriving w... RFC-0016 A release carries its documentation and an install script Every release attaches a docs bundle, archdoc_<version>_docs.tar.gz, holding user guides written under docs/guides/, the reference RFC-0014 defines, PROCESS.md,... RFC-0018 The registry records every change since v0.5.1 Each rule's Changes records every change to what the rule reports in a release after v0.5.1, the last release tagged before the registry was built, including th...