Docs vs code drift for API teams

Methodology: diff · optional AI · human review

Paste your published docs (or OpenAPI excerpt) next to a PR/changelog. Get a prioritized drift report — paths, params, and examples that no longer match — for API/SDK teams before customers (or coding agents) hit a dead page.

1. What the engine owns

Severity-ranked findings from pasted docs vs change text. Demo is labelled Rule-based — never silent mock.

2. What optional AI may do

Explain or polish findings when a key is configured. Upstream failure returns 502. No invented endpoints.

3. What you must do

  • Review findings against the real API before editing docs.
  • Apply fixes in your docs repo — PaperDrift does not open PRs.
  • Treat output as decision-support, not a conformity certificate.

4. What we deliberately do not do

  • Live API crawling / continuous monitoring.
  • Auto-merge or rewrite of production docs.
  • Replace a docs CMS or SpecDrift-style CI gate.

Assinar

Este resultado foi útil?Comentários