Skip to content

Commit 7816b3c

Browse files
hongyi-chenoz-agentclaude
committed
missing_docs: fix audit for Astro layout, refresh surface map, document Kitty keyboard protocol
The audit script assumed a `docs/` subdirectory layout and `.md` filenames, so on the current Astro Starlight tree (`src/content/docs/`, `.mdx`) every mapped doc resolved as missing. This refreshes the skill so it produces useful signal again. - audit_docs.py: resolve doc paths from the repo root, accept .md/.mdx interchangeably (and README.md → index.mdx), add --weak-coverage flag for the strict keyword check, broaden keyword extraction to handle slash-command flags (RewindSlashCommand → /rewind) and UI-suffix flags. - feature_surface_map.md: update every entry to the actual `.mdx` paths, fix `agent-platform/warp-agents/*` mappings that should be either `local-agents/*` or `capabilities/*`, add ListSkills/SyncAmbientPlans to the ignore list (server-side). - SKILL.md: document `--weak-coverage` and the `.md`/`.mdx` resolution. - full-screen-apps.mdx: add a Kitty keyboard protocol section so the newly-shipped flag is documented where TUI users will look. Default audit now runs clean for features/CLI/API; `--weak-coverage` surfaces ~30 mapped pages where the feature isn't named verbatim, for follow-up review. Co-Authored-By: Oz <oz-agent@warp.dev> Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent c2922c5 commit 7816b3c

4 files changed

Lines changed: 284 additions & 159 deletions

File tree

.agents/skills/missing_docs/SKILL.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,23 @@ Find documentation gaps and draft missing pages in one workflow.
2121
Run the audit script to identify gaps:
2222

2323
```bash
24-
python3 .warp/skills/missing_docs/scripts/audit_docs.py
24+
python3 .agents/skills/missing_docs/scripts/audit_docs.py
2525
```
2626

2727
Options:
2828
- `--category features|cli|api|staleness` — run a single audit category
2929
- `--severity high|medium|low` — filter by minimum severity
30+
- `--weak-coverage` — also flag GA features whose mapped doc exists but doesn't mention feature keywords (low-severity, noisy)
3031
- `--output report.json` — save JSON report to file
3132
- `--warp-internal PATH` — explicit path to warp-internal (auto-detected from sibling dirs)
3233
- `--warp-server PATH` — explicit path to warp-server (auto-detected from sibling dirs)
3334

35+
The script resolves doc paths from the docs repo root and accepts `.md` and `.mdx`
36+
interchangeably (and `README.md``index.mdx`), so surface-map entries can use the
37+
canonical filename even when the on-disk extension differs.
38+
3439
The script performs 4 audits:
35-
1. **Feature flag coverage** — compares GA flags in `warp_core/src/features.rs` + `app/Cargo.toml` against doc mentions
40+
1. **Feature flag coverage** — compares GA flags in `crates/warp_features/src/lib.rs` + `app/Cargo.toml` against the surface map; default mode trusts a mapped entry as verified, `--weak-coverage` additionally checks the target page mentions feature keywords
3641
2. **CLI command coverage** — compares `warp_cli/src/lib.rs` subcommands against `src/content/docs/reference/cli/`
3742
3. **API endpoint coverage** — compares `router/router.go` routes against `src/content/docs/reference/api-and-sdk/` and the OpenAPI spec
3843
4. **Docs staleness** — checks for outdated terminology in existing docs

0 commit comments

Comments
 (0)