docs(skills): missing_docs audit bookkeeping (surface map + snapshot) - #494
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
force-pushed
the
docs/missing-docs-audit-bookkeeping
branch
from
August 12, 2026 17:26
efcdb59 to
a9b5d8a
Compare
hongyi-chen
marked this pull request as ready for review
August 12, 2026 19:13
Contributor
|
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 |
Contributor
There was a problem hiding this comment.
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 buildpassed.npm run typecheckpassed with zero errors.- Missing-docs map hygiene was clean, snapshot regeneration produced no diff, and audit tests passed.
Verdict
Approved.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Bookkeeping for the
missing_docsdrift-watch audit, rebased ontomainand re-derived from today'swarpandwarp-servercheckouts. Every standing coverage finding is now either documented in a sibling PR or explicitly mapped here.Surface map
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-subscriptionPUT,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..well-knownOAuth discovery entries, including the RFC 8414 section 5 path-aware variants.AgentCliLaunchModal, the one-time Warp Agent CLI launch modal, matching the other launch-modal flags.appearance.zero_state.freeze_animation_when_unfocusedatagents/cli/configuration.mdx; the CLI docs moved out ofsrc/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
register*helpers, not just exportedRegister*ones. Route registration functions likeregisterMCPDiscoveryRouteswere 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
--update-snapshot.Remaining findings after this PR
Two groups, both covered by sibling PRs:
GET /agent/artifacts/{uid}/download,GET /agent/run-by-external-reference,POST /agent/runs/{runId}/scores) — docs: sync agent-api-openapi.yaml from warp-server #499./connect-grok,/manage-billing,/upgrade) — docs: document the new Warp Agent CLI slash commands #493.Deferred findings
Nothing else was dropped silently. For the record:
factory-mcpskill, stays undocumented. Factory is not publicly released (FactoryMcpis dogfood), so per the skill's public/private guardrail it is mappedinternaland the bundled skill is left out of the skills docs.oz memory*and/memory_stores/*remain deferred behindgated:AIMemorieswhile 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.MultiLevelOrchestration(dogfood),PricingTransparency(dogfood), andPeriodicHandoffCheckpoints(other) are snapshot-tracked only; the diff will flag them on promotion.TuiCostTransparencywas removed from code, and its user-facing surface (/costand the CLI credit chips) is already documented.evaluationsandevaluations/:evaluationIdroutes are gone; no docs page referenced them, so there is nothing to prune.style_lintskill, which owns wording. Spot checks show most are deliberate:privacy.mdxreproduces telemetry event names fromtelemetry.json,faqs.mdxrefers to the retired "Warp AI chat panel" as history,generate.mdxis explicitly labeled Legacy, theagent-modehits 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-serverexits 0 with no findings besides the two groups above and the delegated terminology items; completeness accounting reports no unaccounted surfaces.npm run buildpasses.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.