Skip to content

docs(audit): refresh missing_docs surface map and snapshot#332

Draft
hongyi-chen wants to merge 1 commit into
mainfrom
oz/docs-audit-bookkeeping
Draft

docs(audit): refresh missing_docs surface map and snapshot#332
hongyi-chen wants to merge 1 commit into
mainfrom
oz/docs-audit-bookkeeping

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Summary

Companion audit-bookkeeping PR for the missing_docs drift-watch run. Collects the shared surface-map and snapshot changes so they don't conflict across the feature PRs.

  • Surface map: allowlist two intentionally unlisted pages in the "Unlisted docs pages" section:
    • 404 — the custom Starlight 404 page (template: splash), rendered through Starlight's own /404 route, so it's intentionally not in the sidebar.
    • platform/integrations/jira — the Jira integration page is draft: true (private beta; the Oz Jira app isn't published to the Atlassian marketplace yet). Kept out of the sidebar until GA; the snapshot diff will re-flag it on promotion.
  • Snapshot: regenerated via --update-snapshot. Advances the changelog baseline to 2026.07.09 and records the new agents.usage_display_mode setting, the oz agent run-cloud harness flags, the NldPromptHistoryMatch dogfood flag, and the POST /factory/avatar route.

Findings addressed in sibling PRs

Deferred findings (nothing silently dropped)

API endpoints — deferred to the sync-openapi-spec skill (kept separate per policy). warp-server is private; these 19 public-API routes are not in the released OpenAPI spec, so they must not be hand-documented. Route released ones through sync-openapi-spec; map the rest internal after confirming status:

  • GET /agent/artifacts/{uid}
  • GET /agent/events, GET /agent/events/stream, POST /agent/events/{run_id}
  • POST /agent/messages, GET /agent/messages/{run_id}, POST /agent/messages/{id}/read, POST /agent/messages/{id}/delivered
  • GET|PUT|DELETE /agent/schedules/{id}, POST /agent/schedules/{id}/pause, POST /agent/schedules/{id}/resume
  • GET|POST /factory, GET|PATCH|DELETE /factory/{uid}, POST /factory/avatar

Terminology / staleness (32 low-severity findings) — deferred to the style_lint skill, which owns terminology and style enforcement (e.g. "warp ai", "ai credits", "agent-mode", "warp terminal", "ambient agent" phrasings across ~32 pages).

Changelog items (verified, no dedicated docs needed):

  • Cross-window tab dragging re-enabled (#13411) — already documented in terminal/windows/tabs.mdx ("Move a tab to another window").
  • Markdown syntax highlighting in the editor (#13034), "Copy file path" in the file viewer menu (#13145), scrollable custom-inference model lists (#12647), and the heap-profile command palette action (#13107) — minor UI polish covered by the changelog; no dedicated docs warranted.

Snapshot-only: NldPromptHistoryMatch (dogfood) — tracked only; no docs until promotion.

Validation

  • Audit re-run: addressed coverage findings resolved; remaining findings are the deferred API + terminology items above.
  • npm run build passes on the combined tree.

Conversation: https://staging.warp.dev/conversation/0ee78198-1342-4558-b918-b484f4655005
Run: https://oz.staging.warp.dev/runs/019f5c6b-ee12-75f1-a353-e0ef6e3edd4f

This PR was generated with Oz.

- Allowlist the Starlight 404 splash page and the draft Jira integration
  page (draft: true, non-GA) in the surface map's unlisted-pages section.
- Regenerate surface_snapshot.json (advances changelog baseline to
  2026.07.09; records new agents.usage_display_mode setting, run-cloud
  harness CLI flags, NldPromptHistoryMatch dogfood flag, and the
  POST /factory/avatar route).

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

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

Request Review

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.

1 participant