From 1ec20174b765d609c8028c50980008a4d394218a Mon Sep 17 00:00:00 2001 From: Jared Knowles Date: Sun, 23 Aug 2026 23:26:33 -0400 Subject: [PATCH] chore: move compass out of docs/, which pkgdown deletes compass.toml, JOURNAL.md, STATUS.md and decisions/ were sitting inside pkgdown's output directory. Asked directly, pkgdown listed docs/pm and docs/decisions among the 28 top-level entries clean_site() would delete, and the guard that would have refused -- check_dest_is_pkgdown() -- was satisfied by docs/pkgdown.yml. After the move it lists 26 and none of them are compass's. Nothing was lost. The journal had no entries and there were no decision records yet, so this was the cheapest moment to move. The .gitignore workaround goes with it. Re-including two children of an excluded docs/ forced the rule to be written as /docs/* plus two negations, which changed the anchoring and made the fixture corpus's own docs/ need a separate rule. A bare docs/ matches at any depth again, so both are unnecessary. .Rbuildignore gains ^pm$ -- R CMD check flags a non-standard top-level directory. Compass reads both layouts, so this repository worked either way; the point is that docs/ is a directory another tool empties. --- .Rbuildignore | 1 + .gitignore | 16 +++++--------- {docs/pm => pm}/JOURNAL.md | 0 {docs/pm => pm}/STATUS.md | 36 +++++++++++++------------------- {docs/pm => pm}/compass.toml | 0 {docs => pm}/decisions/README.md | 0 6 files changed, 21 insertions(+), 32 deletions(-) rename {docs/pm => pm}/JOURNAL.md (100%) rename {docs/pm => pm}/STATUS.md (70%) rename {docs/pm => pm}/compass.toml (100%) rename {docs => pm}/decisions/README.md (100%) diff --git a/.Rbuildignore b/.Rbuildignore index ba6315b..fcb3c6d 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -3,6 +3,7 @@ ^\.Rproj\.user$ ^_pkgdown\.yml$ ^docs$ +^pm$ ^Meta$ ^doc$ ^pkgdown$ diff --git a/.gitignore b/.gitignore index ccbe719..fe4e6d7 100644 --- a/.gitignore +++ b/.gitignore @@ -4,17 +4,11 @@ .Ruserdata *.Rproj inst/doc -# pkgdown output. Listed as children rather than `docs/` so compass's -# docs/pm/ and docs/decisions/ can be re-included -- git cannot re-include -# anything beneath an excluded directory. -# -# Note the anchoring change this forces: a bare `docs/` matches a directory of -# that name at ANY depth, while `/docs/*` matches only at the repo root. The -# fixture corpus's own docs/ therefore needs its own rule to stay excluded. -/docs/* -!/docs/pm/ -!/docs/decisions/ -inst/extdata/fixture_corpus/docs/ +# pkgdown output. Compass used to keep its files in docs/pm/ and +# docs/decisions/, which forced this to be written as children with two +# re-includes -- git cannot re-include anything beneath an excluded directory. +# Compass lives in pm/ now, so the whole directory can be excluded again. +docs/ /doc/ /Meta/ .DS_Store diff --git a/docs/pm/JOURNAL.md b/pm/JOURNAL.md similarity index 100% rename from docs/pm/JOURNAL.md rename to pm/JOURNAL.md diff --git a/docs/pm/STATUS.md b/pm/STATUS.md similarity index 70% rename from docs/pm/STATUS.md rename to pm/STATUS.md index b77b06b..59bb0a7 100644 --- a/docs/pm/STATUS.md +++ b/pm/STATUS.md @@ -14,14 +14,23 @@ The six open issues split cleanly. Two are API work carried out of the #9 review and deliberately deferred there rather than fixed in that branch. Three concern the corpus layer, and the largest of them, partition-level caching, was named the single highest-leverage change on the remote path before being deferred. One, the -data-correction intake, is a decision rather than a task: it was parked during the -0.3.0 design and it gates the API announcement, because without it the corpus cannot -make the "traceable and correctable" claim that most distinguishes it from Census's -own files. +data-correction intake (#52), is a decision rather than a task: it was parked during +the 0.3.0 design, and the API announcement waits on it, because without it the corpus +cannot make the "traceable and correctable" claim that most distinguishes it from +Census's own files. Nothing here is blocked on anything else, so the ordering is a judgement about value rather than a dependency graph. +Compass's own files moved out of `docs/` this session. They were sitting inside +pkgdown's output directory, and `pkgdown::clean_site()` deletes every top-level entry +there except `CNAME` and `dev` — asked directly, it listed `docs/pm` and +`docs/decisions` among the 28 it would remove, with the guard that would have stopped +it satisfied by `docs/pkgdown.yml`. They are in `pm/` now. Nothing was lost: the +journal had no entries and there were no decision records yet, which made this the +cheapest moment to move. The `.gitignore` workaround that re-included two children of +an excluded `docs/` is gone with it. + ## Ready to work on next - **#34** cog_revenue() offers expenditure recipes as suggestions: scope the candidate query by category_type · `ws/api` — nothing is blocking it; something is currently wrong @@ -47,25 +56,10 @@ rather than a dependency graph.
Dependency graph and detail -```mermaid -graph TD - I34["#34 cog_revenue() offers expenditure recipes as sug…"] - I36["#36 n_units_reporting is category-conditional and c…"] - I2["#2 Extend population data to be households as an a…"] - I33["#33 Decompose .build_suggestions() (106 lines) into…"] - I52["#52 Release 11/11: design the data-correction intak…"] - I64["#64 Partition-level caching: R/cache.R is still a s…"] - class I34 ready; - class I36 ready; - class I2 ready; - class I33 ready; - class I52 ready; - class I64 ready; - classDef ready fill:#dafbe1,stroke:#2da44e; -``` +_Nothing blocks anything else, so there is no graph to draw._ - Marker: `none` (no journal entry yet) -- Commits since: 164 +- Commits since: 165 - Open issues: 6
diff --git a/docs/pm/compass.toml b/pm/compass.toml similarity index 100% rename from docs/pm/compass.toml rename to pm/compass.toml diff --git a/docs/decisions/README.md b/pm/decisions/README.md similarity index 100% rename from docs/decisions/README.md rename to pm/decisions/README.md