docs(skills): missing_docs audit bookkeeping (surface map + snapshot) - #494
Draft
hongyi-chen wants to merge 1 commit into
Draft
docs(skills): missing_docs audit bookkeeping (surface map + snapshot)#494hongyi-chen wants to merge 1 commit into
hongyi-chen wants to merge 1 commit 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.
|
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.
Companion bookkeeping PR for a
missing_docsdrift-watch run. It carries everyfeature_surface_map.mdandsurface_snapshot.jsonchange from the run, so the sibling feature PR stays focused and the shared files don't conflict. Independently mergeable in any order: every mapped target already exists onmain.Audit inputs:
warpdotdev/warp(public client) andwarp-server, both audits exiting 0 with no skipped audits and no unaccounted surface items.Surface map changes
New GA feature flag —
AgentCliLaunchModal→ ignore list. It's the one-time modal announcing the Warp Agent CLI (app/src/workspace/view/agent_cli_launch_modal/). It shows once, links out to the CLI get-started page, and has no recurring user-facing surface. Same treatment asOzLaunchModal,OpenWarpLaunchModal,OrchestrationLaunchModal, andCodeLaunchModal. The CLI it announces is documented undersrc/content/docs/cli/.New API routes —
POST /oauth/consentandGET /oauth/consent/info→internal. They back the web consent screen for third-party OAuth clients (router/handlers/public_api/oauth2.go):/consent/infomaps aclient_idto the display name shown on the screen, andPOST /consentrecords the grant thatGET /oauth/authorizeredirects to. They're browser-facing plumbing for the already-internalauthorize flow and are absent from warp-server's canonical public spec, so they aren't a documentable public API surface.Map hygiene — Warp Agent CLI slash commands and settings re-pointed at real pages. Sixteen
TuiOnlyslash commands (/exit,/status,/api-keys,/theme,/vim-mode, and so on) and several CLI-only settings were mapped tointernalwith comments saying they weren't documented. That stopped being true once the CLI docs landed: they're documented incli/reference.mdx,cli/index.mdx, andcli/configuration.mdx. Mapping them to those pages makes the map's claims accurate and keeps the audit honest if a page is ever deleted.appearance.zero_state.extrusion_depthandagents.voice.voice_input_hold_keystayinternal— neither is documented anywhere, andextrusion_depthis a rendering detail of the built-in start-screen object.The three new slash commands (
/connect-grok,/manage-billing,/upgrade) are documented in the sibling PR and mapped here alongside their peers.Snapshot
surface_snapshot.jsonregenerated with--update-snapshot. It picks up theAgentCliLaunchModalflag, the two OAuth consent routes, and the three new slash commands, so the next run diffs against a clean baseline.Deferred findings
Nothing was silently dropped. The two remaining categories are deliberately routed elsewhere:
3 public API endpoints missing from the published OpenAPI spec (medium)
GET /agent/artifacts/{artifactUid}/download(agent_artifacts.go)GET /agent/run-by-external-reference(agent_webhooks.go)POST /agent/runs/{runId}/scores(run_score_reports.go)All three are present in warp-server's canonical
public_api/openapi.yamlwithoutx-internal, so they belong in the publisheddevelopers/agent-api-openapi.yamlsubset. They are not hand-documented here: warp-server is private, and the skill routes released API changes throughsync-openapi-spec.That sync is deferred rather than run in this batch, because
sync_openapi.py --mode diffshows the regeneration is much wider than these three paths, and it would publish research-preview Agent Memory schemas:/harness-support/transcript. Operations changed:/agent/artifacts/{artifactUid},/agent/identities,/agent/runs.AgentMemoryCreateConfig,AgentAutoMemoryCreateConfig,AgentMemoryResponse,AgentAutoMemoryResponse, andMemoryStoreAttachmentResponse. These aren't reachable from a memory endpoint (thememory_storespaths are excluded by policy) — they're pulled in transitively through thememoryfield onCreateAgentRequest/AgentResponse.Agent Memory is research preview (its gating flag
AIMemoriesis non-GA, which is whyoz memory*and/memory_stores/*aregated:AIMemoriesin this map). Publishing those schemas would expose it in the public API reference. Per the skill's "when unsure, defer — never expose" guardrail, this needs a deliberate decision before the sync runs.Recommended next step: either have warp-server mark the
memoryfield and its schemasx-internalin the canonical spec, or extendEXCLUDED_PATHS/schema policy in.agents/skills/sync-openapi-spec/scripts/sync_openapi.py, then runsync-openapi-specas its own PR. Owners for these handlers did not resolve from warp-server'sSTAKEHOLDERS/CODEOWNERS, so that PR needs manual reviewer assignment.30 low-severity terminology findings (owned by
style_lint)Reviewed individually. Most are false positives from the substring matcher:
agent-mode(6 files) — matches URL slugs (/terminal-and-agent-modes/,/warp-drive/agent-mode-context/) and image filenames (agent-mode-locked-universal-input.png), not prose.warp ai/ai command(privacy.mdx, faqs.mdx, terminal/entry) — historical telemetry event names in reference tables (Toggle Warp AI,Opened Warp AI), the live feature name "AI Command Search", and one deliberately historical FAQ heading ("What happened to the old Warp AI chat panel?"). None should be renamed.generate command(agents/local-agents/generate.mdx) — the page documents the#Generate feature itself.Two are genuine but belong to a terminology sweep, not this audit:
AI credits(12 files) —AGENTS.mdsays use "credits" without the AI prefix, but the billing docs use "AI credits" as the name of one of three buckets alongside compute credits and platform credits. Renaming it needs a product-terminology decision, applied consistently across billing, enterprise, and error pages.Warp Terminal(8 files) — style preference for "Warp" unless distinguishing from Oz.The
missing_docsskill explicitly delegates pure wording issues tostyle_lint, so these are left for astyle_lintrun.Clean categories
CLI commands, settings, docs structure (unlisted pages), stale doc references, map hygiene, and changelog review all produced zero findings this run.
Conversation: https://staging.warp.dev/conversation/52a9f9f7-2e0a-43ae-82c4-84a04c9d4eb1
Run: https://oz.staging.warp.dev/runs/019fdd2a-edce-719d-9dc1-678ca78ec7e0
This PR was generated with Oz.