Name the commit the knowledge base's records now come from, and link research with touches and decisions with rests-on (review of #312)
This commit is contained in:
@@ -20,7 +20,7 @@ written into this repository.
|
||||
3. **Propose the decision record.** `mesh_call knowledge-base.propose` with the reserved `number`, `title`,
|
||||
`topic` (one of the six in [`02-DECISIONS/README.md`](../../../02-DECISIONS/README.md)), `date`,
|
||||
`deciders`, `clauses` (each `"**Lead.** the statement"`), `sections` (Context, Considered Options,
|
||||
Consequences, How it is checked, References), `links` (`extends`, `supersedes`, `changes` with
|
||||
Consequences, How it is checked, References), `links` (`extends`, `rests-on`, `supersedes`, `changes` with
|
||||
`"NNNN §N"`, `cites`), `homes` (the design's path), and `needs-operator: true` when the operator must
|
||||
approve it. A refusal names every rule broken: fix them all and propose again. The knowledge base
|
||||
reviews it itself; on `changes` revise and propose again with `why`. `knowledge-base.get` shows its
|
||||
|
||||
@@ -22,7 +22,7 @@ All through the mesh MCP server (`mesh_describe` gives each verb's arguments).
|
||||
3. **Propose the effort.** `mesh_call knowledge-base.propose` with `kind: research`, the reserved `number`,
|
||||
`title`, `status: active`, `date` (today), `sections` (the documents in order, each `name` and `text`;
|
||||
the first `00-overview.md`: **what** is investigated, **why**, and **what it touches**), and `links`
|
||||
of kind `cites` for every record, effort, issue or design it touches.
|
||||
of kind `touches` for every record, effort, issue or design it touches (`cites` for one it only names).
|
||||
4. **Do the research** in further documents of the same effort. Each change is `propose` again with the
|
||||
effort whole and `why`. A refusal names every rule broken: fix them all and propose again. On review
|
||||
`changes`, revise and propose again; `knowledge-base.get` shows the reviews.
|
||||
|
||||
@@ -13,7 +13,7 @@ generated on demand and never written back to disk.
|
||||
|
||||
| Section | Files | Frontmatter |
|
||||
|---|---|---|
|
||||
| Research | the knowledge base, not a file: `knowledge-base.ask`, and `knowledge-base.get` with `kind: research` and a number | `status` (`active` / `graduated` / `abandoned`), `date`, links (`became`, `cites`) |
|
||||
| Research | the knowledge base, not a file: `knowledge-base.ask`, and `knowledge-base.get` with `kind: research` and a number | `status` (`active` / `graduated` / `abandoned`), `date`, links (`became`, `touches`, `cites`) |
|
||||
| Design | `03-DESIGN/**/*.md` (not READMEs) | `layer` (`as-is` / `to-be`), `status` (`designed` / `in-progress` / `implemented` / `abandoned`), `code`, `updated`, `decisions` |
|
||||
| Decisions | the knowledge base, not a file: `knowledge-base.holds` with a topic (the clauses in force, with their records), `knowledge-base.get` with a number, `knowledge-base.links` | `status` (`proposed` / `accepted` / `superseded`), `topic`, `date`, `deciders`, each clause's status, links both ways, what changed it since |
|
||||
| Issues | the issue tracker, not a file: `mesh_call issue-tracker.list` (optionally `status`, `owner`, `phrase`) and `issue-tracker.get` | `status` (`open` / `diagnosing` / `located` / `fixing` / `resolved` / `wontfix`), `worker` and `stale` while `diagnosing` or `fixing`, `opened`, `located-in`, `fixed-by`, `amended-design`, `record` (the folder here, when it has one) |
|
||||
|
||||
@@ -27,8 +27,9 @@ the claim "HQ is the source" is checked.
|
||||
3. Publish it to the knowledge base under the constitution slug, replacing the body.
|
||||
4. **Read it back and verify the change is present.** A publish that reported success and did
|
||||
nothing is exactly the failure class this repository exists to name — do not skip this.
|
||||
5. Note the sync in the decision record's Consequences (in the knowledge base: `knowledge-base.propose`
|
||||
the proposed record again with the note and `why`).
|
||||
5. Note the sync in the decision record's Consequences (in the knowledge base: while the record is
|
||||
proposed, `knowledge-base.propose` it again with the note and `why`; once it is accepted, `propose` it with
|
||||
`insight`, saying what stood before).
|
||||
|
||||
## Do not
|
||||
|
||||
|
||||
@@ -23,8 +23,7 @@ README = "02-DECISIONS/README.md"
|
||||
|
||||
# A topic in the README's reading order, e.g.
|
||||
# 1. **What the mesh is** — `topic: the mesh`. What it is for, ...
|
||||
# The knowledge base (mesh-knowledge, reference.go) and the records module's `records_decisions` read the
|
||||
# same line, so the form is a contract.
|
||||
# The knowledge base (mesh-knowledge, reference.go) reads the same line, so the form is a contract.
|
||||
TOPIC_LINE = re.compile(r"^\d+\.\s+\*\*(?P<label>[^*]+)\*\*\s+—\s+`topic:\s*(?P<topic>[^`]+)`", re.M)
|
||||
|
||||
# What a stored list looks like: the old markers, or a line of the list index.py used to print.
|
||||
|
||||
@@ -20,8 +20,8 @@ is written with the knowledge base's verbs, never as a folder here.
|
||||
3. **Propose it.** `knowledge-base.propose` with `kind: research`, the `number` reserve gave, a one-line
|
||||
`title`, `status: active`, `date` (the day it began), and `sections`: its documents in order, each a
|
||||
`name` and its markdown `text`. The first is `00-overview.md`: **what** is being investigated, **why**,
|
||||
and **what it touches**. Name what it touches as `links` of kind `cites` (`"0276"`, `"research 045"`,
|
||||
`"issue 365"`, or a design's path), not only in prose.
|
||||
and **what it touches**. Name what it touches as `links` of kind `touches` (`"0276"`, `"research 045"`,
|
||||
`"issue 365"`, or a design's path), not only in prose, and what it names for another reason as `cites`.
|
||||
4. **Do the research** in further documents of the same effort: notes, option analyses, evidence, draft
|
||||
designs. Each change is `knowledge-base.propose` again with the effort whole and `why`, one line saying
|
||||
why this version. Every version is kept; `knowledge-base.history` lists them and gives the difference
|
||||
|
||||
@@ -48,7 +48,7 @@ clauses in force for a topic or a record).
|
||||
- `sections`: the reasoning, in order: `Context` (what was true, with evidence), `Considered Options`
|
||||
(numbered, each with why it was rejected), `Consequences` (what follows, including what got harder),
|
||||
`How it is checked` (a rule states how it is checked), `References`;
|
||||
- `links`: `extends` for a record it builds on, `supersedes` for one it replaces whole, `changes` with
|
||||
- `links`: `extends` for a record it builds on, `rests-on` for a decision it stands on, `supersedes` for one it replaces whole, `changes` with
|
||||
the clause it replaces part of (`"0276 §4"`, and `from` for the clause of this record that does it),
|
||||
`cites` for any record, effort, issue or design it names;
|
||||
- `homes`: the documents of this repository that cite it, such as the design's path;
|
||||
|
||||
@@ -8,5 +8,5 @@ This repository keeps no copy. From any node and any folder, through the mesh MC
|
||||
number (`reasoning: true`, or `section` with a document's name, for its documents). An effort is started
|
||||
with `knowledge-base.reserve` and `knowledge-base.propose`, as playbook
|
||||
[01](../00-META/process/01-research.md) says, and closed through playbook
|
||||
[02](../00-META/process/02-graduation.md). The efforts left this folder at hq commit f08920199d25, which
|
||||
the knowledge base's import read (issue 426).
|
||||
[02](../00-META/process/02-graduation.md). The efforts left this folder at hq commit 76b346af,
|
||||
the commit the knowledge base's records name as their source (issue 426).
|
||||
|
||||
@@ -7,8 +7,8 @@ place a record is read. This repository keeps no copy. From any node and any fol
|
||||
server: `knowledge-base.ask` with a question in plain words, `knowledge-base.get` with a number (and
|
||||
`reasoning: true` for the why), `knowledge-base.holds` with a topic below for the clauses in force. A record
|
||||
is written with `knowledge-base.reserve` and `knowledge-base.propose`, as playbook
|
||||
[02](../00-META/process/02-graduation.md) says. The records left this folder at hq commit f08920199d25,
|
||||
which the knowledge base's import read (issue 426).
|
||||
[02](../00-META/process/02-graduation.md) says. The records left this folder at hq commit 76b346af,
|
||||
the commit the knowledge base's records name as their source (issue 426).
|
||||
|
||||
## Reading order
|
||||
|
||||
|
||||
@@ -575,7 +575,7 @@ silent.
|
||||
## 12. The defects to fix first
|
||||
|
||||
Found in the built Telegram code of the output seat's holder and the watcher
|
||||
(028/04).
|
||||
(research 028, its document 04-telegram-as-the-first-holder).
|
||||
|
||||
| # | What | Fix | Weight |
|
||||
|---|---|---|---|
|
||||
|
||||
Reference in New Issue
Block a user