Skip to content

Add drift doc-freshness tooling and topic docs#1117

Open
busbyk wants to merge 3 commits into
mainfrom
tooling
Open

Add drift doc-freshness tooling and topic docs#1117
busbyk wants to merge 3 commits into
mainfrom
tooling

Conversation

@busbyk

@busbyk busbyk commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Description

Sets up drift to bind docs to the code they describe, so docs get flagged for review when bound code changes. Adds the drift workflow (script, lockfile, pre-commit + CI) and three topic docs.

Related Issues

N/A

Key Changes

  • scripts/drift-check.mjs — wraps drift check, excluding vendored Claude skill bundles to avoid false-positive broken links
  • drift.lock — 118 doc→code bindings (CLAUDE.md, topic docs, ADRs)
  • drift:check script, .husky/pre-commit step, and a CI drift job (installs drift v0.10.0)
  • CLAUDE.md "Doc Drift" section documenting the workflow
  • New docs: docs/decisions/README.md (ADR index), docs/troubleshooting.md, docs/error-tracking.md
  • Fixes 3 broken doc links drift surfaced (ADR-010 path, ADR-005 heading, ADR template)

How to test

pnpm drift:check → reports "docs ok". The CI drift job runs the same.

Migration Explanation

N/A — no schema/DB changes.

Future enhancements / Questions

Follow up PRs:

Set up `drift` to bind docs to the code they describe so docs get flagged
when bound code changes:

- scripts/drift-check.mjs: JSON wrapper that excludes vendored Claude skill
  bundles from false-positive broken links
- drift.lock: 118 bindings (CLAUDE.md + topic docs + ADRs -> code)
- drift:check script, pre-commit step, and a CI `drift` job (installs
  drift v0.10.0, runs pnpm drift:check)
- CLAUDE.md "Doc Drift" section documenting the workflow
- Fix two real broken doc links drift surfaced (ADR-010 path + template)

Establish three docs and bind them:

- docs/decisions/README.md: ADR index
- docs/troubleshooting.md: common local-dev failures
- docs/error-tracking.md: Sentry + PostHog wiring
- Fix ADR-005 placeholder heading

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Preview deployment: https://tooling.preview.avy-fx.org

busbyk and others added 2 commits June 16, 2026 23:52
…ng main

Merging main surfaced stale drift bindings: docs/testing.md described the
e2e auth setup as logging in "via the UI", but main moved auth.setup.ts to
authenticate over the REST login endpoint (POST /api/users/login). Correct
the doc (REST flow, userRoles list, per-test performLogin note) and re-link
the testing.md -> e2e bindings (and CLAUDE.md -> testing.md) to the current
code state.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

2 participants