Proposals¶
This is the index for numbered technical specifications and substantial decisions. Proposals work like lightweight ADRs or RFCs.
Reserve a number in this index before creating its folder. Use a stable ID such
as HMD-0001, with the proposal itself at HMD-0001/README.md.
HMD-0002 through HMD-0019 are reserved for the Python and MkDocs line of
work. Editor and JavaScript proposals start at HMD-0020, so the two streams
can reserve numbers without coordinating. When the Python numbering exhausts 0019
it continues at HMD-0100, leaving 0020–0099 to the editor line.
| ID | Status | Title | Progress |
|---|---|---|---|
| HMD-0001 | drafted | MVP — grammar, resolver, and hmd lint |
lang, hmd |
| HMD-0002 | drafted | MkDocs book-mode rendering | hmd, pages |
| HMD-0003 | drafted | HQL — the Hyper Query Language (stub, no syntax) | lang |
| HMD-0004 | drafted | The hyper web — namespaces beyond one tree (stub, no mechanism) | lang |
| HMD-0005 | drafted | The HyperMarkDown rename — domain, repository, and registries | hmd |
| HMD-0006 | drafted | Extended URI for transclusion and link referencing when addressing inside a card | lang |
| HMD-0020 | drafted | @hypermarkdown/core — the TypeScript document model |
ts-core |
| HMD-0021 | drafted | The VS Code extension — the HyperMarkDown preview surface | vsc-ext |
| HMD-0022 | drafted | Diagrams as committed artifacts | ts-core, vsc-ext |
| HMD-0023 | reserved | Searching the wiki from the preview | — |
| HMD-0024 | drafted | The tools/ layout, and a Python language server |
hmd |
| HMD-0025 | drafted | The graph tab — the vault as a picture | vsc-ext |
Progress is tracked per tool¶
Work is tracked in doc/status/, one file per thing that ships:
lang.md for the format itself, hmd.md
for the canonical Python implementation, ts-core.md and
vsc-ext.md for the TypeScript implementation and its
editor, and pages.md for the site. Those files are the
only place work is tracked; there is no repository-wide task list and no
board.
A proposal is a record and carries no tracker of its own. The split is
decision versus state: the record changes when the design changes, and the
tracker changes with the commits. A proposal's rows are spread across whichever
trackers own the code — the Progress column above says which — because a
proposal is an argument and a tool is a thing you can ship, and the second is
what a reader wants the state of. See
doc/wiki/tracking.hmd for the convention in full.
The editor line also keeps a board in doc/issues/ for defects
found against a running extension; a card there becomes a tracked row when it is
picked up.