docs(skills): missing_docs audit bookkeeping (surface map + snapshot) - #494
Draft
hongyi-chen wants to merge 3 commits into
Draft
docs(skills): missing_docs audit bookkeeping (surface map + snapshot)#494hongyi-chen wants to merge 3 commits into
hongyi-chen wants to merge 3 commits into
Conversation
Bookkeeping for this drift-watch run: - Ignore AgentCliLaunchModal (one-time Warp Agent CLI launch modal). - Map POST /oauth/consent and GET /oauth/consent/info as internal (browser-facing plumbing for the OAuth authorize flow). - Point the Warp Agent CLI-only slash commands and settings at the CLI doc pages that actually document them instead of 'internal'. - Refresh surface_snapshot.json. Co-Authored-By: Warp Agent <agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…w server routes The public API extractor only followed exported `Register*` call sites, so routes registered by unexported helpers were dropped from the audit universe. warp-server moved the MCP OAuth discovery routes into `registerMCPDiscoveryRoutes`, which made two live routes look removed and turned their surface-map entries into false 'dead entry' hygiene findings. The extractor now follows both spellings, which also surfaces the two path-suffixed RFC 8414 discovery variants. Maps the remaining routes the audit newly detected, all internal: OAuth grants/registration/revocation (third-party MCP client plumbing), harness-support/commit-snapshot, and the new Factory integration, scorer, and automation-subscription routes. Snapshot regenerated against warp master 7469abe. Co-Authored-By: Warp Agent <agent@warp.dev>
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.
Bookkeeping for the
missing_docsdrift-watch audit: surface-map entries, the regenerated snapshot, and one fix to the audit script itself. No user-facing docs change here — those ship in the companion feature PRs.Audit script fix
parse_public_api_routesonly followed exportedRegister*call sites when walking warp-server's route registration graph. warp-server has since moved the MCP OAuth discovery routes into an unexported helper,registerMCPDiscoveryRoutes, so those routes silently dropped out of the audit's universe. That produced two misleading signals: a--diff"route removed" finding and two map-hygiene "dead entry" findings for routes that are very much alive.The extractor now follows both spellings. Following the helper also surfaces the two path-suffixed RFC 8414 discovery variants that were never extracted before, which are mapped below.
This is the failure mode worth flagging: the audit reported removal for something that had only moved. Pruning those map entries, which is what the hygiene finding literally suggests, would have been wrong.
Surface map
internalwith a rationale that no longer holds ("not documented on the public slash-commands page"). They are documented, on the CLI reference page, so they now map there.AgentCliLaunchModal- Ignore-list entry. A one-time launch modal in the same class asOzLaunchModalandOrchestrationLaunchModal: it shows once, links to the CLI get-started page, and has no recurring surface.internalto the CLI configuration page that documents them.internal- OAuth consent/grants/registration/revocation (browser and machine plumbing for third-party MCP clients, none in warp-server's canonical public spec),harness-support/commit-snapshot(x-internal: truein the canonical spec), the four new path-suffixed OAuth discovery documents, and the new Factory integration, scorer, and automation-subscription routes (Factory is not a released product;FactoryMcpis dogfood).Verification
test_audit_docs.py— 12/12 pass, including the snapshot round-trip and the completeness accounting check.test_suggest_reviewers.py— 15/15 pass.unaccounted: none.Three
undocumented_api_endpointsfindings remain on this branch and are expected:GET /agent/artifacts/{uid}/download,GET /agent/run-by-external-reference, andPOST /agent/runs/{runId}/scoresare public in warp-server's canonical spec but stale in the docs copy. They are fixed by the companion OpenAPI sync PR, which ownsdevelopers/agent-api-openapi.yaml.Deferred findings
Recorded here so nothing is dropped silently.
30 low-severity staleness findings — deferred to
style_lint. Every one is a false positive or needs a product decision:agent-mode(5 files) — all hits are URL slugs (/terminal-and-agent-modes/,/agent-mode-context/) and image filenames, not prose. The staleness check strips code spans but not link targets.warp ai/ai command/ambient agentinprivacy.mdx— verbatim telemetry event names and their descriptions. That table is generated fromtelemetry.jsonby therelease_updatesskill, so hand-edits would be overwritten. Fixing the wording means changing the event descriptions upstream.warp aiinagents/getting-started/faqs.mdx— the heading "What happened to the old Warp AI chat panel?" is deliberately historical.ai commandinterminal/entry/index.mdx— "AI Command Search", an actual feature name.warp terminal(9 files) — "Warp Terminal" used where it is legitimately distinguished from the CLI or Oz.ai credits(10 files) — the real conflict. The style guide says use "credits" without the AI prefix, but the docs consistently name three buckets: AI credits, compute credits, and platform credits. Dropping the prefix from "alongside AI credits and compute credits" would make those sentences ambiguous. This needs a terminology decision on what the first bucket is called, not a mechanical rename.81
--weak-coveragefindings — no action. All are keyword-matching noise: the check looks for flag-name-derived phrases (e.g. "handoff local cloud" forHandoffLocalCloud) that never appear in prose. Every one maps to a real, verified page. The flag is off by default for this reason.3 changelog items:
SKILLS_DIRSenv var in agent-driver mode — deferred.agent-driverdoes not exist in the publicwarpdotdev/warpcheckout, so this is an internal harness surface, not a public one.factory-mcpbundled skill — deferred. The skill ships in the public client, but it drives the hosted Warp Factory product (thewarp-factoryMCP server, factory tasks, foreman) which has no public documentation and whose API is dogfood-gated. Documenting the skill would expose an unreleased product surface. Re-flag when Factory ships.MultiLevelOrchestrationflag — tracked only. Dogfood; the snapshot diff will re-flag it on promotion.Reviewers
scripts/suggest_reviewers.pyresolved@moirahuangand@warpdotdev/oss-maintainersfrom the warp.github/STAKEHOLDERS. The four warp-server handler paths behind the API entries (oauth2.go,factories.go,agent_artifacts.go,public_api/openapi.yaml) had no owner match and are left for manual assignment.Conversation: https://staging.warp.dev/conversation/7e6d979d-88a2-46f0-90e1-6404a7edc72e
Run: https://oz.staging.warp.dev/runs/019fec9e-026d-7b44-bc62-8d6c8e2ccf6b
This PR was generated with Oz.