Skip to content

docs(missing_docs): audit bookkeeping (surface map + snapshot)#341

Merged
hongyi-chen merged 1 commit into
mainfrom
docs/missing-docs-audit-bookkeeping
Jul 17, 2026
Merged

docs(missing_docs): audit bookkeeping (surface map + snapshot)#341
hongyi-chen merged 1 commit into
mainfrom
docs/missing-docs-audit-bookkeeping

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Summary

Companion audit-bookkeeping PR for the missing_docs drift-watch run. Updates the surface map and regenerates the surface snapshot so the next audit diffs against a clean baseline. No user-facing docs change here (those ship in the sibling feature PRs).

Surface map changes (references/feature_surface_map.md)

  • PinnedTabsterminal/windows/tabs.mdx (feature went GA; documented in docs: document Pinned tabs #339). Removed its old ignore-list entry.
  • TerminalLifecycleRecovery → ignore list. It's an internal reliability mechanism (state-mutating recovery for abnormal terminal lifecycle sequences) with no user-facing configuration or UI.
  • oz runner CRUD → gated:CloudAgentRunnerCLICommands. The command group is gated by a dogfood-only flag, so it auto-defers until GA.
  • Pruned stale entries for removed flags: RunAgentsTool (orchestration stabilized/GA; still documented at platform/orchestration/multi-agent-runs.mdx), PRCommentsSlashCommand (slash command removed; see docs: remove /pr-comments slash command #340), and ignore-list entries OrchestrationViewerStreamer / OwnerOrchestrationAncestorStreamer (flags removed from code).

Snapshot

  • Regenerated references/surface_snapshot.json (--update-snapshot). This clears the surface_changes and changelog_review diffs for this run.

Validation

  • Coverage audit: addressed findings resolved (feature-flag, CLI, slash, and map-hygiene findings all at 0; completeness accounting clean, unaccounted: none).
  • Diff audit: surface_changes and changelog_review cleared.
  • npm run build passed (347 pages built).

Deferred findings (not silently dropped)

These remain open by design and are not addressed in this run:

Public Oz Agent API endpoints missing from the OpenAPI spec (27) — route via sync-openapi-spec, do not hand-document. warp-server is private, and none of these are in the released developers/agent-api-openapi.yaml, so per the skill's public/private guardrail they are deferred pending release-status confirmation:

  • agent/artifacts/{uid}, agent/artifacts/{uid}/download
  • agent/events, agent/events/stream, agent/events/{run_id}
  • agent/messages, agent/messages/{id}/delivered, agent/messages/{id}/read, agent/messages/{run_id}
  • agent/schedules/{id} (GET/PUT/DELETE), agent/schedules/{id}/pause, agent/schedules/{id}/resume
  • factory, factory/{uid} (GET/PATCH/DELETE), factory/avatar, factory/automations (+ {id}, events/{provider}, {id}/subscriptions, {id}/subscriptions/{subscription_id})

Terminology / staleness findings (32) — owned by the style_lint skill. Pure wording issues (e.g. "warp ai", "ai credits", "agent-mode", "ambient agent", "warp terminal") across billing, inference, harness, privacy, and terminal pages are delegated to style_lint rather than fixed here.

Dogfood-only / non-GA surfaces — tracked, no docs. BoxDrawingGlyphs, OscHyperlinks, CloudAgentRunnerCLICommands, GeminiEnterprise, NldPromptHistoryMatch. The snapshot will re-flag them on GA promotion.

Other verified-covered items: the /mcp slash command is TUI-only and already counts as doc-covered; AsyncFind (now GA) is already covered by the documented experimental.async_find_enabled setting. Changelog "improvements" items were reviewed and are minor UI changes not needing dedicated docs.

Conversation: https://staging.warp.dev/conversation/ce1c5f13-b8a2-497f-843e-57f84d63b745
Run: https://oz.staging.warp.dev/runs/019f7105-5e3a-7d03-8d21-1a7784c46f9a

This PR was generated with Oz.

…audit

- Map PinnedTabs -> terminal/windows/tabs.mdx (feature went GA; documented).
- Move PinnedTabs out of the ignore list now that it is GA and mapped.
- Ignore TerminalLifecycleRecovery (internal reliability mechanism, no user surface).
- Defer oz runner CRUD via gated:CloudAgentRunnerCLICommands (dogfood-gated).
- Prune stale map/ignore entries for removed flags (RunAgentsTool,
  PRCommentsSlashCommand, OrchestrationViewerStreamer,
  OwnerOrchestrationAncestorStreamer).
- Regenerate surface_snapshot.json.

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Jul 17, 2026
@vercel

vercel Bot commented Jul 17, 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, Comment Jul 17, 2026 5:14pm

Request Review

@hongyi-chen
hongyi-chen requested review from bnavetta and ianhodge July 17, 2026 17:11
@hongyi-chen
hongyi-chen marked this pull request as ready for review July 17, 2026 17:23
@oz-for-oss

oz-for-oss Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

@hongyi-chen

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

You can follow along in the session on Warp.

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

Powered by Oz

@hongyi-chen
hongyi-chen enabled auto-merge (squash) July 17, 2026 17:23
@hongyi-chen
hongyi-chen merged commit a6c2c53 into main Jul 17, 2026
8 checks passed
@hongyi-chen
hongyi-chen deleted the docs/missing-docs-audit-bookkeeping branch July 17, 2026 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants