Skip to content

docs(skills): missing_docs audit bookkeeping (surface map + snapshot) - #494

Merged
hongyi-chen merged 3 commits into
mainfrom
docs/missing-docs-audit-bookkeeping
Aug 12, 2026
Merged

docs(skills): missing_docs audit bookkeeping (surface map + snapshot)#494
hongyi-chen merged 3 commits into
mainfrom
docs/missing-docs-audit-bookkeeping

Conversation

@hongyi-chen

@hongyi-chen hongyi-chen commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator

What changed

Bookkeeping for the missing_docs drift-watch audit, rebased onto main and re-derived from today's warp and warp-server checkouts. Every standing coverage finding is now either documented in a sibling PR or explicitly mapped here.

Surface map

  • Maps the warp-server routes this audit surfaced as internal: Factory scorers (PATCH/DELETE, pause, resume, results reasons), Factory run scoring and autofix, Factory GitHub/Linear/Slack integration lookups, Factory benchmark suites and runs, the automation-subscription PUT, POST /harness-support/commit-snapshot, and the OAuth consent, grants, register, and revoke endpoints. Factory is still unreleased and the OAuth endpoints are protocol/browser plumbing, so none belong in the public spec.
  • Restores and extends the .well-known OAuth discovery entries, including the RFC 8414 section 5 path-aware variants.
  • Ignores AgentCliLaunchModal, the one-time Warp Agent CLI launch modal, matching the other launch-modal flags.
  • Points appearance.zero_state.freeze_animation_when_unfocused at agents/cli/configuration.mdx; the CLI docs moved out of src/content/docs/cli/ in docs: consolidate the Warp Agent CLI docs into the Agents section #486, so the old target no longer existed and the setting was reported as undocumented.

Audit script

  • Route extraction now follows unexported register* helpers, not just exported Register* ones. Route registration functions like registerMCPDiscoveryRoutes were silently dropped from the audit universe, hiding 14 real routes (the four OAuth discovery documents and ten Factory benchmark routes) and making the discovery documents look like they had been removed.

Snapshot

  • Regenerated with --update-snapshot.

Remaining findings after this PR

Two groups, both covered by sibling PRs:

Deferred findings

Nothing else was dropped silently. For the record:

  • Factory — every Factory REST route, plus the new bundled factory-mcp skill, stays undocumented. Factory is not publicly released (FactoryMcp is dogfood), so per the skill's public/private guardrail it is mapped internal and the bundled skill is left out of the skills docs.
  • Agent Memoryoz memory* and /memory_stores/* remain deferred behind gated:AIMemories while the feature is in research preview. They will re-surface automatically when the flag goes GA. Related: docs: sync agent-api-openapi.yaml from warp-server #499 flags memory schemas that ride along in warp-server's public spec.
  • Non-GA flagsMultiLevelOrchestration (dogfood), PricingTransparency (dogfood), and PeriodicHandoffCheckpoints (other) are snapshot-tracked only; the diff will flag them on promotion. TuiCostTransparency was removed from code, and its user-facing surface (/cost and the CLI credit chips) is already documented.
  • Removed Oz web app routes — the evaluations and evaluations/:evaluationId routes are gone; no docs page referenced them, so there is nothing to prune.
  • Linux background computer use fix — a behavior fix with no doc-visible surface.
  • 30 low-severity terminology findings — delegated to the style_lint skill, which owns wording. Spot checks show most are deliberate: privacy.mdx reproduces telemetry event names from telemetry.json, faqs.mdx refers to the retired "Warp AI chat panel" as history, generate.mdx is explicitly labeled Legacy, the agent-mode hits are URL slugs, and "AI credits" is used intentionally in the billing docs to contrast with compute and platform credits.

Validation

python3 .agents/skills/missing_docs/scripts/audit_docs.py --warp ../warp --warp-server ../warp-server exits 0 with no findings besides the two groups above and the delegated terminology items; completeness accounting reports no unaccounted surfaces. npm run build passes.

Note on this revision

This branch replaces the earlier revision of this PR, which was written against an older main. Its route-parser fix and several of its route mappings are carried forward; the map entries it removed for Warp Agent CLI-only settings and slash commands are restored, since those surfaces are documented on the CLI pages rather than in the all-settings reference and their removal produced 16 false findings.

Conversation: https://staging.warp.dev/conversation/1bda9ae7-44b1-43c5-bb7a-d22ccf8b6c16
Run: https://oz.staging.warp.dev/runs/019ff6ea-bc3c-7336-b1f5-9f1f5b89cd84

This PR was generated with Oz.

@hongyi-chen hongyi-chen added the documentation Improvements or additions to documentation label Aug 7, 2026
@cla-bot cla-bot Bot added the cla-signed label Aug 7, 2026
@vercel

vercel Bot commented Aug 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 12, 2026 7:18pm

Request Review

hongyi-chen and others added 2 commits August 12, 2026 17:16
Maps newly added warp-server routes as internal, ignores the Warp Agent CLI
launch modal flag, fixes the moved CLI configuration doc path, prunes removed
.well-known entries, and regenerates the surface snapshot.

Co-Authored-By: Warp Agent <agent@warp.dev>
Maps the warp-server routes surfaced by this audit as internal (Factory
scorers, autofix, integrations and benchmarks, OAuth consent/grants/register/
revoke, harness-support commit-snapshot, and the OAuth discovery documents),
ignores the Warp Agent CLI launch modal flag, points the Warp Agent CLI
zero-state setting at its moved configuration page, teaches the route parser to
follow unexported register* helpers, and regenerates the surface snapshot.

Co-Authored-By: Warp Agent <agent@warp.dev>
@guyscherzer8
guyscherzer8 force-pushed the docs/missing-docs-audit-bookkeeping branch from efcdb59 to a9b5d8a Compare August 12, 2026 17:26
@hongyi-chen
hongyi-chen marked this pull request as ready for review August 12, 2026 19:13
@oz-for-oss

oz-for-oss Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

@hongyi-chen

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I cancelled the in-progress review run because this pull request was closed.

Powered by Oz

@warp-agent-staging warp-agent-staging Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review summary

Reviewed the missing_docs audit bookkeeping update. The route-registration handling, surface map, and regenerated snapshot are internally consistent; no findings remain.

Validation

  • GitHub CI checks passed.
  • npm run build passed.
  • npm run typecheck passed with zero errors.
  • Missing-docs map hygiene was clean, snapshot regeneration produced no diff, and audit tests passed.

Verdict

Approved.

@hongyi-chen
hongyi-chen merged commit 1e6b4d4 into main Aug 12, 2026
7 of 8 checks passed
@hongyi-chen
hongyi-chen deleted the docs/missing-docs-audit-bookkeeping branch August 12, 2026 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant