Repository navigation
docs: add docs/README.md index and audience tags (part of #6420) - #6719
Merged
Merged
Conversation
Add an index of every page in docs/, an Audience line under each page title, and the missing operator pages in the root README docs table.
This was referenced Oct 24, 2026
erikdarlingdata
marked this pull request as ready for review
October 24, 2026 17:11
There was a problem hiding this comment.
Verdict: LGTM
Claims
- VERIFIED — "New
docs/README.md... lists every page indocs/in seven groups... Thedocs/changelog/files are one group link." —docs/README.mdlists all 36 non-changelog.mdpages underdocs/(cross-checked againstfind docs -name "*.md"minuschangelog/), one line each, withchangelog/linked once as a directory. - VERIFIED — "An
Audience:line under the H1 of 34 pages." —gh pr diff --name-onlyshows 36 changed files; subtractingREADME.mdand the newdocs/README.mdleaves exactly 34 pages that each gained a two-lineAudience:insertion after their H1 (e.g.docs/alerts.md:1-3,docs/editions.md:1-3). - VERIFIED — "Root
README.mddocs table: added six rows...darling-store-sizing,signed-webhooksanddarling-agent-dispatchwere already in the table." — the diff hunk atREADME.md:64-72shows exactly 6+rows, andsigned-webhooks.md/darling-agent-dispatch.mdrows appear as unchanged context further down. - VERIFIED — "Line endings are unchanged... Every file in
docs/is CRLF, so the new index is CRLF too." —file docs/README.mdreports "ASCII text, with CRLF line terminators", matchingfile docs/editions.md. - VERIFIED — "Every relative link in
docs/README.mdand the root README resolves to a file in the tree." — resolved every(...)mdtarget in both files against the actual tree; all exist (docs/mcp-server.md,docs/darling-store-sizing.md,docs/darling/*, etc.). - VERIFIED — "Every non-changelog page in
docs/appears in the index." — extracted all 36 link targets fromdocs/README.mdand diffed againstfind docs -name "*.md" -not -path "*/changelog/*" -not -path docs/README.md; the sets match exactly. - UNVERIFIED — "
mcp-server.md(#6635 edits lines 6 to 12)" / "darling-store-sizing.md(#6683 edits lines 1 to 6)" and the other open-PR line-range claims used to justify the two untagged pages — this run's allowedghcommands are scoped to PR 6719 only, so the cited PRs' diffs could not be checked. The underlying premise (both files currently lack theAudience:line others got) is confirmed by reading the files. - UNVERIFIED — "scrubcheck on this body, the commit message and the full diff: 0 hits." — scrubcheck is an external process not inspectable from a read-only tree.
- UNVERIFIED — "I did not build or run the .NET tests." — the diff-shape part of this claim ("this PR only adds lines under titles and adds a new file") is VERIFIED from the diff itself; whether tests were actually run is not checkable from the tree. Independently traced every test that reads a touched doc file (
EntraDefaultCredentialTests.cs:503,EntraDeviceCodeTests.cs:452/1573/2494ondocs/authentication.md;LiteRuntimePrerequisiteDocsTests.cs:58/148ondocs/lite-guide.md;PgColumnStatsCoverageTests.cs:481ondocs/postgres-first-target-runbook.md) — all assert by heading-scoped section (SectionOf, structural) orAssert.Contains/DoesNotContainon substrings, never by line number or line count, so the insertedAudience:lines cannot break them.
Riskiest lines
docs/README.md(new, ~65 lines) — a dense new link index; a typo'd path would be a silent dead link — UNCOVERED (no markdown link-checker in this repo's CI, confirmed by grepping.github/workflows/formarkdown-link-check/lychee).docs/lite-guide.md:3,docs/authentication.md:3,docs/postgres-first-target-runbook.md:3(newAudience:lines in files consumed by behaviour tests) — risk of shifting content these tests scope by position — covered byLiteRuntimePrerequisiteDocsTests.EveryShippedLiteArtifact_IsPublishedSelfContained(heading-boundedSectionOf) andEntraDefaultCredentialTests.TheReadmeAuthenticationCountMatchesTheConstants(substringAssert.Contains), both of which scope by heading/content, not line number, so they would fail on a defect that corrupted those sections and pass here.README.md:72— new "Documentation index" row pointing atdocs/README.md, creating two co-existing indices (root table vs.docs/README.md) that could drift out of sync over time — UNCOVERED (no test enforces the two tables agree), but this is an explicit, acknowledged structure in the PR body, not a defect.
Traps near this diff
.gitattributessaystext=auto eol=crlf... "A diff that touches every line of a file is a line-ending conversion until proven otherwise" — does not apply: every hunk in this diff is a 2-line insertion with surrounding context lines unchanged (e.g.docs/editions.md:1-9), not a whole-file rewrite, andfileconfirms CRLF preserved on both old and new files.- "Lite and Darling ship in parity... a fix to one SKU's reader, tool, alert or description without the counterpart's is a finding" — does not apply: no SKU-specific reader, tool, alert or collector was touched; every change is prose in
docs/andREADME.md. - "Ruling (#5833): tests are load-bearing... never answer a trap with a test that reads source text" — does not apply: no test files are touched in this diff, and no new test was added to cover the doc changes (none of the Riskiest lines above warrant one per that ruling).
Divergence (blind read vs PR body)
None — the body's account matches the diff on every claim graded above. The blind read independently found the same two untagged pages (mcp-server.md, darling-store-sizing.md) as an apparent gap in the "34 pages tagged" pattern; the PR body's explanation (open PRs editing those files' first lines) resolves it, though the specifics of those other PRs are outside this run's tool scope to confirm.
Reviewer checklist
- Spot-check a handful of rendered links from
docs/README.mdand the newREADME.mdrows in a Markdown preview (e.g. GitHub's PR file view) to confirm anchors/paths render as expected, since this was checked by path resolution only, not rendering.
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
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.
Claude posting for Erik Darling.
Part of #6420.
docs/mixed operator pages with design notes and maintainer pages, and had no index. This PR adds one, labels each page by audience, and fills the gaps in the root README table.What changed
docs/README.md. It lists every page indocs/in seven groups: Install, Run, Configure, Monitor your servers, Reference, Design notes and Maintainers. Each page has one line. Thedocs/changelog/files are one group link.Audience:line under the H1 of 34 pages. Operator pages sayAudience: operators.The two PostgreSQL design notes say they are history and not a procedure.how-collection-works.mdandbuilding-from-source.mdsay contributors.releasing.mdsays maintainers.README.mddocs table: added six rows. They are the store backup guide, the Darling guides index, the PostgreSQL target runbook, the Retention Held runbook, how collection works, and a link to the full index.darling-store-sizing,signed-webhooksanddarling-agent-dispatchwere already in the table.docs/is CRLF, so the new index is CRLF too.Pages left untagged
Open PRs change the first 10 lines of these two files, so tagging them now would conflict. Tag them after those PRs merge.
mcp-server.md(Agents can recompile a module and create or drop a plan guide through Level 3 server actions, with Undo (#6569) #6635 edits lines 6 to 12)darling-store-sizing.md(Docs: record the #5794 load test results in the sizing guide #6683 edits lines 1 to 6)editions.mdhunks in #6619 start at line 37 and in #6655, #6631 and #6618 at line 43, none in the first 10 lines. Soeditions.mdis tagged.mcp-server.mdhunks in #6655, #6631, #6618 and #6619 start at line 67, but #6635 edits line 6, so it is untagged.darling-agent-dispatch.md(#6635 at line 201),how-collection-works.md(#6619 at line 56) andlite-guide.md(#6619 at line 76) are tagged. Also untagged by rule: the changelog files andsignpath_logo.svg.Checks
docs/README.mdand the root README resolves to a file in the tree.docs/appears in the index.Not in this PR
docs/design/. Code comments, tests,darling.sample.jsonandDarling/README.mdpoint at them, and open PRs editDarling/README.md. The moves go with the Split Darling/README.md (509 KB, 2,269 lines, 106 headings) into task pages and a generated reference #6416 README split.docs/tabs.mdandDarling/README.md. This also goes with Split Darling/README.md (509 KB, 2,269 lines, 106 headings) into task pages and a generated reference #6416.Darling/README.mdis untouched.CHANGELOG entry
None. This is docs only.