Make great documentation goal 1.2, and plan the README's reorganisation and the nested-template gaps #33

Open
lilleman wants to merge 966 commits from worktree-todo-relative-dates-exact-counts into main
2 changed files with 12 additions and 2 deletions
Showing only changes of commit 98fffe31be - Show all commits
+3 -2
View File
@@ -958,7 +958,7 @@ the Development section below, and who ships a register the four above then draw
- **The changelog heading is the one spelling of a release; CI cuts the tag.** A
tag pushed by hand is served by `go get` at once, so a tag whose commit lacks its
heading is burnt, not fixed. The heading on a gate-passed `main` commit is the
trigger instead: the tag can land only there, and the Gitea release the same job
trigger instead: the tag can land only there, and the GitHub release the same job
publishes keeps one text as its body and is where prebuilt binaries will attach.
- **A `--data-path` override rebinds every reference to the category it
replaces.** References bind against the merged tree, so once shipped data uses
@@ -1344,6 +1344,7 @@ data.go data loading: fs.FS folders/files -> namespace tree, multi-sourc
cmd/fejkdata/ the fejkdata CLI
data/ shipped data (JSON, and a TSV per table), embedded at build: locale folders, geo, misc
data-import/ the scripts that rebuild each sourced table (see DATA-LICENSES.md)
docs/ the register research behind the shipped data, and the survey of other libraries
release-tooling/ the release CI publishes from the changelog heading
testdata/ the pinned shipped shape (see Versioning)
```
@@ -1433,7 +1434,7 @@ docker compose run --rm --user "$(id -u):$(id -g)" data-import data-import/usera
To release, head `CHANGELOG.md` with the version's section in place of `Unreleased`
and merge: once `main` passes the gate, CI tags that commit `vX.Y.Z` and publishes
the Gitea release with the section as its body. A top heading of `[Unreleased]`
the GitHub release with the section as its body. A top heading of `[Unreleased]`
publishes nothing.
## License
+9
View File
@@ -262,6 +262,15 @@ because pairing a street with its exact postnummer rewrites shipped rows.
- Name goal 2's four criteria with the axes the panel scores, so a recorded score maps
back to the clause it came from: the goal spells them out in prose while `todo.md`
records `Navigation`, `Locality`, `Shape` and `Self-sufficiency`.
- Put the round's nine-seat score and the four-seat score every later pull request
takes on one scale, or say in `AGENTS.md` that they are two ratchets: it gates the
round on the first and every merge after 7.0 on the second, then holds one "last
score" across both, where the `comprehension-panel` skill has two independent panels
drift unless a calibration seat reads the anchor project without its score.
- Name the draw fences at one level in `doc.go`: the Vocabulary calls them `heldCheck`,
`drawCheck` and `checkFamilies`, where `checkFamilies` runs under `drawCheck` beside
`checkOwnFamily` and `checkColumnDraws`, which it names nowhere — so a reader looking
for the fence over a record's columns finds no entry reaching it.
- Scope `AGENTS.md`'s `Hard tabs.` to the Go source, or drop it: `gofmt` already gates
Go at `Dockerfile:21`, and the shipped JSON under `data/` is two-space, so the rule as
written is one no Go file can break and every data file does.