ArchDoc Design record

Overview Index Glossary Review

› Spec 12

Architecture Commands Documents Export Index Layout Lifecycle Links and the glossary Lint Markdown Relationships Release

› Records

Proposals RFC 17

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

Decisions ADR 24

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

References REF 0

ArchDoc

Overview Index Glossary Review

› Spec 12

Architecture Commands Documents Export Index Layout Lifecycle Links and the glossary Lint Markdown Relationships Release

› Records

Proposals RFC 17

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

Decisions ADR 24

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

References REF 0

Search results

Search this record

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

↑↓ move All results and filters ↵