Skip to content

docs: add docs/README.md index and audience tags (part of #6420) - #6719

Merged
erikdarlingdata merged 2 commits into
devfrom
docs/6420-docs-index
Oct 24, 2026
Merged

erikdarlingdata merged 2 commits into
devfrom
docs/6420-docs-index

Conversation

@erikdarlingdata

@erikdarlingdata erikdarlingdata commented Oct 24, 2026 •

Copy link
Copy Markdown
Owner

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

  • New docs/README.md. It lists every page in docs/ in seven groups: Install, Run, Configure, Monitor your servers, Reference, Design notes and Maintainers. Each page has one line. The docs/changelog/ files are one group link.
  • An Audience: line under the H1 of 34 pages. Operator pages say Audience: operators. The two PostgreSQL design notes say they are history and not a procedure. how-collection-works.md and building-from-source.md say contributors. releasing.md says maintainers.
  • Root README.md docs 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-webhooks and darling-agent-dispatch were already in the table.
  • Line endings are unchanged. Every file in 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.

editions.md hunks in #6619 start at line 37 and in #6655, #6631 and #6618 at line 43, none in the first 10 lines. So editions.md is tagged. mcp-server.md hunks 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) and lite-guide.md (#6619 at line 76) are tagged. Also untagged by rule: the changelog files and signpath_logo.svg.

Checks

  • Every relative link in docs/README.md and the root README resolves to a file in the tree.
  • Every non-changelog page in docs/ appears in the index.
  • scrubcheck on this body, the commit message and the full diff: 0 hits.
  • I did not build or run the .NET tests. Some tests read docs files, but this PR only adds lines under titles and adds a new file.

Not in this PR

CHANGELOG entry

None. This is docs only.

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.
@erikdarlingdata
erikdarlingdata marked this pull request as ready for review October 24, 2026 17:11

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verdict: LGTM

Claims

  • VERIFIED — "New docs/README.md... lists every page in docs/ in seven groups... The docs/changelog/ files are one group link." — docs/README.md lists all 36 non-changelog .md pages under docs/ (cross-checked against find docs -name "*.md" minus changelog/), one line each, with changelog/ linked once as a directory.
  • VERIFIED — "An Audience: line under the H1 of 34 pages." — gh pr diff --name-only shows 36 changed files; subtracting README.md and the new docs/README.md leaves exactly 34 pages that each gained a two-line Audience: insertion after their H1 (e.g. docs/alerts.md:1-3, docs/editions.md:1-3).
  • VERIFIED — "Root README.md docs table: added six rows... darling-store-sizing, signed-webhooks and darling-agent-dispatch were already in the table." — the diff hunk at README.md:64-72 shows exactly 6 + rows, and signed-webhooks.md/darling-agent-dispatch.md rows 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.md reports "ASCII text, with CRLF line terminators", matching file docs/editions.md.
  • VERIFIED — "Every relative link in docs/README.md and the root README resolves to a file in the tree." — resolved every (...)md target 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 from docs/README.md and diffed against find 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 allowed gh commands are scoped to PR 6719 only, so the cited PRs' diffs could not be checked. The underlying premise (both files currently lack the Audience: 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/2494 on docs/authentication.md; LiteRuntimePrerequisiteDocsTests.cs:58/148 on docs/lite-guide.md; PgColumnStatsCoverageTests.cs:481 on docs/postgres-first-target-runbook.md) — all assert by heading-scoped section (SectionOf, structural) or Assert.Contains/DoesNotContain on substrings, never by line number or line count, so the inserted Audience: lines cannot break them.

Riskiest lines

  1. 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/ for markdown-link-check/lychee).
  2. docs/lite-guide.md:3, docs/authentication.md:3, docs/postgres-first-target-runbook.md:3 (new Audience: lines in files consumed by behaviour tests) — risk of shifting content these tests scope by position — covered by LiteRuntimePrerequisiteDocsTests.EveryShippedLiteArtifact_IsPublishedSelfContained (heading-bounded SectionOf) and EntraDefaultCredentialTests.TheReadmeAuthenticationCountMatchesTheConstants (substring Assert.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.
  3. README.md:72 — new "Documentation index" row pointing at docs/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

  • .gitattributes says text=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, and file confirms 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/ and README.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.md and the new README.md rows 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.

@erikdarlingdata
erikdarlingdata merged commit f349289 into dev Oct 24, 2026
17 of 21 checks passed
@erikdarlingdata
erikdarlingdata deleted the docs/6420-docs-index branch October 24, 2026 17:29
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