Files
claude-code-best-practice/changelog/best-practice/concepts/verification-checklist.md
T
Shayan Rais db3cb7cfd3 Add Rule 7 (Beta Badge Currency) to concepts verification checklist
Codify the new check surfaced this run: README ![beta] badges in the Hot
table should still match the upstream docs page banner (research preview,
experimental, env-var gated). Origin: workflow-concepts-agent flagged
Routines, No Flicker Mode, Computer Use, and Code Review as candidates;
re-verification confirmed all four still legitimately carry beta status,
but the drift type wasn't covered by existing description-currency rules.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-04-26 15:43:18 +05:00

3.7 KiB
Raw Blame History

Verification Checklist — README CONCEPTS Section

Rules for verifying CONCEPTS table accuracy. Each rule is checked during every workflow run.

Rules

1. External URL Liveness

  • Category: URL Accuracy
  • What to check: Every external URL in the CONCEPTS table (docs links) returns a valid page
  • Depth: Fetch each URL and confirm it loads the expected page (not a redirect to wrong page)
  • Source to compare against: https://code.claude.com/docs/llms.txt for canonical URL list
  • Date added: 2026-03-02
  • Origin: Permissions URL /iam was found to redirect to Authentication page instead of Permissions

2. Anchor Fragment Validity

  • Category: URL Accuracy
  • What to check: Any URL with an anchor fragment (#section-name) matches an actual heading on the target page
  • Depth: Fetch the page and verify the heading exists with the expected anchor
  • Source to compare against: Fetched page content
  • Date added: 2026-03-02
  • Origin: Rules anchor #modular-rules-with-clauderules was stale; section renamed to #organize-rules-with-clauderules

3. Missing Docs Pages

  • Category: Missing Concepts
  • What to check: Every page in the official docs index (llms.txt) that represents a user-facing feature has a corresponding row in the CONCEPTS table
  • Depth: Compare full docs index against CONCEPTS table entries
  • Source to compare against: https://code.claude.com/docs/llms.txt
  • Date added: 2026-03-02
  • Origin: Multiple missing concepts found (Agent Teams, Keybindings, Model Configuration, etc.)
  • Category: Badge Accuracy
  • What to check: Every badge target path in the CONCEPTS table (best-practice/*.md, implementation/*.md, .claude/*/) points to a file or directory that exists
  • Depth: Use Read/Glob to verify file existence
  • Source to compare against: Local filesystem
  • Date added: 2026-03-02
  • Origin: Initial checklist creation

5. Description Currency

  • Category: Description Accuracy
  • What to check: Each concept's description accurately reflects the current official docs description
  • Depth: Compare README description against the official page's meta description or first paragraph
  • Source to compare against: Official docs page content
  • Date added: 2026-03-02
  • Origin: Memory description missing auto memory; MCP Servers location missing .mcp.json

6. TIPS Section URL Consistency

  • Category: URL Accuracy
  • What to check: When a URL is updated in the CONCEPTS or Hot table, also check the TIPS section for the same stale URL
  • Depth: Search TIPS section (lines 125267) for every URL that was flagged in the CONCEPTS/Hot table
  • Source to compare against: llms.txt sitemap + CONCEPTS table URLs
  • Date added: 2026-04-16
  • Origin: web-scheduled-tasks URL was fixed in Hot table (2026-04-14) but the same stale URL persisted in TIPS (line 223)

7. Beta Badge Currency

  • Category: Badge Accuracy
  • What to check: Concepts marked ![beta](!/tags/beta.svg) in the Hot table should still be flagged as beta / research preview in their official docs page (header banner, "research preview" copy, or env-var gating)
  • Depth: Fetch each upstream page and check for explicit beta/preview/experimental wording; if absent, the README badge may be stale
  • Source to compare against: Official docs page banner text + GA-marker copy
  • Date added: 2026-04-26
  • Origin: Workflow-concepts-agent flagged Routines, No Flicker Mode, Computer Use, and Code Review as carrying README beta badges while their docs pages read as GA (confidence 0.6) — this drift type isn't covered by the existing description-currency rule