Skip to content

Drop the last issue ref, honest and slice note from the guides - #1486

Merged
danielgwilson merged 2 commits into
mainfrom
docs/readme-prose-tells
Oct 3, 2026
Merged

danielgwilson merged 2 commits into
mainfrom
docs/readme-prose-tells

Conversation

@danielgwilson

Copy link
Copy Markdown
Owner

Docs only. This is the cleanup that waited for #1461. Once #1471, #1472 and #1476 land, the docs root has no issue refs and no honest hits left.

What changed

  • README.md: the PII/PHI detector line links the open issue as "planned", replacing the [#108] link text.
  • AGENTS.md: the words prose:check counts in src/ string literals are now code spans, because the sentence names them as terms. They are "a later slice", "fail closed", "by construction", "hollow", "honest" and "(s)".
  • docs/README.md: deleted "Both keep dated slice notes beside the current rules". Title reference pages by subject, and cut their slice history #1446 and Clean the prose tells out of five architecture pages #1462 removed those notes.
  • docs/architecture/external-public-shared-world.md: rewrote "The 0.20.0 delta is a single surgical callback" and "later proved unreliable". The paragraph now describes the callback and the CDP read as they work today.

Counts (from #1459's checker)

docs root before after
issue-refs 1 0
honest 1 0

The README "judged by a file's bytes rather than its name" stays, because both halves are real alternatives.

Release line: none. This changes docs only.

Checked

  • format:check, docs:check, prose:check.
  • The luxin slop check: 0 hits.
  • The counts above.
  • gitleaks: no leaks.

Not checked

  • Rendered Markdown.

🤖 Generated with Claude Code

- README: the PII/PHI detector line links the open issue as "planned"
  in place of "[#108]".
- AGENTS.md: the words prose:check counts in src string literals ("a
  later slice", "fail closed", "by construction", "hollow", "honest",
  "(s)") are code spans, since the sentence names them as terms.
- docs/README.md: "Both keep dated slice notes beside the current
  rules" is gone; #1446 and #1462 removed those notes.
- external-public-shared-world.md: "The 0.20.0 delta is a single
  surgical callback" and "later proved unreliable" describe the
  callback and the CDP read as they are now.

Counts by the docs prose ratchet (#1459), before -> after: docs
issue-refs 1 -> 0, honest 1 -> 0 (the last hit of each in the docs
root outside the queued #1471 and #1472). The README "bytes rather than
its name" stays: both halves are real alternatives.

Checked: format:check, docs:check, prose:check, the luxin slop check
(0 hits), the counts with #1459's checker. Not checked: rendered
Markdown.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
humanish Ready Ready Preview Oct 3, 2026 1:27am UTC

Request Review

danielgwilson added a commit that referenced this pull request Oct 3, 2026
prose:check now reads the current docs under three roots, each capped
in scripts/caps.json at prose.<root>.<kind>:

- docs: the root guides (README, AGENTS, ARCHITECTURE, CONTEXT,
  CONTRIBUTING, SECURITY, TELEMETRY) and docs/ outside history/ and
  evidence/.
- site: site/content/docs/*.mdx except the generated cli.mdx.
- evidence: docs/evidence/. Dated study records are capped so a new
  record adds no tells, and are not cleaned, since a record keeps the
  words it was written in.

docs/history/ and CHANGELOG.md are not read.

Kinds: issue-refs, caps, em-dashes, invariant-refs, authority, honest,
archaeology (plus SLICE 2, phase 2, PR1 of) and contrast (not just, not
merely, rather than). scripts/lib/doc-prose.mjs blanks front matter,
fenced code, code spans, link targets, URLs and markup tags before
counting, and reads repo file names and acronyms (README, WAI-ARIA) as
names in the caps count.

Caps are the counts on 9f033af, after the docs cleanups #1446,
#1452, #1454, #1455, #1462, #1463, #1471, #1472 and #1476, in the kind
order above: docs 1/0/0/0/0/1/0/20, site 0/0/0/0/0/0/0/11, evidence
102/64/31/1/3/5/2/11. The docs issue-ref and honest at 1 are the last
hits, which #1486 removes. The 20 docs and 11 site contrast hits each
name two alternatives a reader would weigh.

AGENTS.md and CONTRIBUTING.md say prose:check covers docs.

Checked on 9f033af: format:check, lint, knip, docs:check,
prose:check, vocabulary:check, typecheck, tests/scripts (211 tests, 5
new in check-doc-prose.test.ts), check-cap-direction against
origin/main (new caps only). Not checked: the full vitest suite.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@danielgwilson
danielgwilson merged commit 562ae71 into main Oct 3, 2026
10 checks passed
@danielgwilson
danielgwilson deleted the docs/readme-prose-tells branch October 3, 2026 01:33
danielgwilson added a commit that referenced this pull request Oct 3, 2026
prose:check now reads the current docs under three roots, each capped
in scripts/caps.json at prose.<root>.<kind>:

- docs: the root guides (README, AGENTS, ARCHITECTURE, CONTEXT,
  CONTRIBUTING, SECURITY, TELEMETRY) and docs/ outside history/ and
  evidence/.
- site: site/content/docs/*.mdx except the generated cli.mdx.
- evidence: docs/evidence/. Dated study records are capped so a new
  record adds no tells, and are not cleaned, since a record keeps the
  words it was written in.

docs/history/ and CHANGELOG.md are not read.

Kinds: issue-refs, caps, em-dashes, invariant-refs, authority, honest,
archaeology (plus SLICE 2, phase 2, PR1 of) and contrast (not just, not
merely, rather than). scripts/lib/doc-prose.mjs blanks front matter,
fenced code, code spans, link targets, URLs and markup tags before
counting, and reads repo file names and acronyms (README, WAI-ARIA) as
names in the caps count.

Caps are the counts on 9983746, after the docs cleanups #1446,
#1452, #1454, #1455, #1462, #1463, #1471, #1472, #1476 and #1486, in
the kind order above: docs 0/0/0/0/0/0/0/20, site 0/0/0/0/0/0/0/11,
evidence 102/64/31/1/3/5/2/11. The 20 docs and 11 site contrast hits
each name two alternatives a reader would weigh.

AGENTS.md and CONTRIBUTING.md say prose:check covers docs.

Checked on 9983746: format:check, lint, knip, docs:check,
prose:check, vocabulary:check, typecheck, tests/scripts (231 tests, 5
new in check-doc-prose.test.ts), check-cap-direction against
origin/main (new caps only). Not checked: the full vitest suite.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Preview — b6ff313b Deployed Oct 3, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant