Draft plan for hygiene sprint - #4
Draft
tomcrane wants to merge 13 commits into
Draft
Conversation
tomcrane
changed the title
…(2026-08-03) Adjunct-queue API largely built by PR #1228 (develop, unreleased) - PRO-08 flipped from "docs overstate" to "docs nearly right, pending release". Adjunct size/storage accounting reworked by PR #1220 (main, internal Optimised flag) - inline updates on ACC-06 and ADJ-13. Issues index refreshed: #1157/#1158/#1160/#1218 closed, #1229/#1233 new, RFC 024 proposed in open PR #1230. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Seven parallel fresh-eyes audits re-verified every card 3-way (old Nextra docs / new Starlight docs / current implementation incl. open PRs). No card was wrong in direction; corrections applied inline (marked with a dated arrow), and 21 new cards integrated directly into the session files: XC-11..13, ACC-15..19, SPA-18..21, PRO-11..13, ADJ-17..18, DIS-22..24, IIIF-14 (register now 134 cards). Session-1 Resolved-list error corrected and promoted to ACC-15 (custom-header PUT returns 201 on update). Provenance file revised: PROV-11..18 added, "14/19 clean" withdrawn, new silent-normative-changes category. Strategic notes added: hand XC-02/03 rulings to Jack's in-flight iiif-presentation PR #641; main = released behaviour PO decision recorded in README. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Adds the 2026-08-03 process advice as ratifiable proposals: mechanical vs decision track, routing conventions through in-flight work (PR #641 / #1230 / #228), samples-as-regression-suite, and the five-step landing pipeline from ruling to merged docs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Capture the PROV-01..17 lost prose into the per-page scratch files, each labelled with a disposition (restore-candidate / park / probably-drop / needs-decision). Annotate stale scratch claims with dated corrections: asset-queries ordering and named-queries pdf/zip + template params are implemented (zip verified end-to-end incl. 16 integration tests and the 202+Retry-After in-process behaviour); the entrypoint queue note is clarified per PO (endpoint present, link missing) and DIS-17 corrected accordingly; queues priority-restriction predicate recorded as verified. New scratch/api-doc/storage.md created. PO-stated design intent recorded in registering-assets scratch and SPA-04: asset.manifest -> single asset manifest link; asset.manifests -> asset.scopes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Samples must be run from the dlcs-docs-client root in module form (python -m p04_entrypoint.entrypoint) so that iiif_cs/settings resolve, .env loads, and cross-sample imports work. Explains why the file-path invocations fail, plus venv setup and a caveat that samples hit the configured API for real. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
All six open items were in fact done at register build (2026-06-25) or in the 2026-08-03 refreshes; dated each with pointers to where the output lives. The mdx-vs-Nextra diff carries a caveat: ten claimed-clean pages have not had the deeper second pass. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The ten-page deep diff and the verify-first live tests were hidden inside done items' caveats; make them explicit unticked entries. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Deep-diffed the remaining ten claimed-clean pages. Four genuinely clean (overview, collections, identifiers, custom-headers); size-restrictions clean on losses with two unsourced additions; space/queues/batch and origin-strategy/single-asset-manifest yield PROV-19..24 plus three new cards: DIS-25 (single-asset-manifest "always a Choice" contradicts code), SPA-22 (origin-strategy credentials "must on POST" is wrong), DIS-26 (thumbs-channel auth claim, verify). Most silent changes verified as unrecorded corrections of old-doc errors. Scratch files updated with the findings, including fixing scratch/queues.md's stale "Global Queue not yet ported" entry and recording PO intent that space.maxUnauthorised is replaced by space-level default max properties. Register now 137 cards; checklist item ticked. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude drafts the batch PRs (one commit per card ID, drafts prepared before Wednesday); session 0 ratifies the list via a veto pass; a named owner per surface reviews and merges; the register records PR numbers per card. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
_mechanical-track.md enumerates the ~30 verified-uncontentious cards in five batches (docs status-codes, docs cosmetics, samples, protagonist annotations, protagonist model fixes) plus a borderline section for the room to assign, with release-gated adjunct-doc changes explicitly excluded. README and register now point at it — session 0's veto pass has a concrete artefact. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
_worked-example.md walks one fictionalised 90-minute session end to end: the mechanical-track veto pass, a convention ruling (XC-01) with its cascade, a full decision card (DIS-14) through ruling / track / owner / artefacts / nuance / sample-parity, the DESIGN-card pattern (SPA-04), session close and the async follow-through. All rulings explicitly illustrative. Linked from README and register. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AI-generated proposal for hygiene sprint:
https://github.com/dlcs/public-docs/blob/june26-fix-discrepancies/scratch/hygiene-sprint/README.md
This is documentation-focussed, so needs to be refined for code-first hygiene considerations - hopefully they align cleanly.
It also has some minor discrepancy fixes:
Pass through docs to spot any simple-to-fix discrepancies
(ie not requiring a code direction decision)
Continues to use scratch files to record things to come back to.