Find docs that may be out of date

When a pull request changes code you mapped to a doc, Archdocs flags that doc for review if it hasn't been updated since the pull request's base commit. Findings cover the paths you map, and a doc Archdocs cannot evaluate is reported as unknown, not stale.

Start free Set up the drift check

Plans: The GitHub App docs drift check is on Team and above. Documentation health is on Business and Enterprise.

archdocs / docs drift

1 architecture doc may be stale

Neutral · Review the mapped doc

Mapping: Dispatch Service
Changed files: services/dispatch/window.ts
Docs: Dispatch architecture
Last updated: 29 Oct 2026, 14:20 UTC

Mapping	Changed files	Docs	Last updated
Dispatch Service	services/dispatch/window.ts	Dispatch architecture	29 Oct 2026, 14:20 UTC

When the check cannot resolve a document or its update time, the result is unknown.

Example after the mapped docs are updated

Architecture docs look up to date

GitHub pull request check from the Archdocs GitHub AppRecreated from Archdocs views with sample data.

Find docs to review with a pull request

See the mapped docs and changed paths behind each drift finding.

Prioritize documentation gaps

Review ownership, coverage and reference findings ranked by impact.

Explain an intentional finding

Keep a reviewer's reason with the acknowledged drift finding.

A finding on the pull request

A reviewer sees which docs may be stale, which changed files triggered the finding and when each doc was last updated.

.archdocs.yml

version: 1
mappings:
  - paths:
      - 'services/billing/**'
    docs:
      - 'PASTE-DOCUMENT-ID-HERE'

.archdocs.ymlExample configuration

Replace PASTE-DOCUMENT-ID-HERE with the mapped document's ID from GitHub settings in Archdocs.

archdocs / docs drift

1 architecture doc may be stale

Neutral · Review the mapped doc

Mapping: Dispatch Service
Changed files: services/dispatch/window.ts
Docs: Dispatch architecture
Last updated: 29 Oct 2026, 14:20 UTC

Mapping	Changed files	Docs	Last updated
Dispatch Service	services/dispatch/window.ts	Dispatch architecture	29 Oct 2026, 14:20 UTC

When the check cannot resolve a document or its update time, the result is unknown.

Example after the mapped docs are updated

Architecture docs look up to date

GitHub pull request check from the Archdocs GitHub AppRecreated from Archdocs views with sample data.

When Archdocs cannot tell, it reports unknown, not stale
The check is informational by default and can be made required
A reviewer can acknowledge a finding with a reason when the documented contract has not changed

Archdocs maps paths you choose; it doesn’t inspect source code.

Resolution

Update the mapped doc, and the next run of the check reports it as current
Or acknowledge the finding with a reason when the documented contract did not change
Age-based documentation health is a separate signal from path-change findings

How to acknowledge a finding

Plans: GitHub App drift check on Team and above.

Documentation health

Find the docs that need attention first, ranked by impact: inbound references, dependents and public exposure. Docs not edited or marked current within the freshness threshold, 90 days by default, are flagged for review.

Unowned docs and undocumented objects
Empty doc slots and broken references

Plans: Documentation health on Business and Enterprise.

Read the documentation health guide

Set it up

Install the GitHub App on Team and above, then map repository paths to docs and objects in a config file.

Read the setup guide Acknowledging findings

Screenshots are from a sample workspace. Recreated views are labeled.

Start free Read the docs