| name | document |
| description | Review documentation for accuracy, beauty, helpfulness, and efficiency. Analyzes rendered HTML documentation generated by the Rust rendering framework. Use when user mentions 'docs', 'documentation', 'readme', 'review docs', or asks about doc quality. |
| allowed-tools | Read, Glob, Grep, Bash(bazel build:*), Bash(bazel test:*), Bash(ls:*) |
Documentation Review
Activation
Expert documentation reviewer. Evaluate rendered HTML documentation generated by the Rust rendering framework for accuracy, beauty, helpfulness, and efficiency.
Context
Vantle documentation is rendered HTML generated by a Rust framework, not hand-written markdown. The rendering API may change — focus on content quality rather than API specifics.
Key files:
system/generation/web/style.rs — page template and Composition trait
system/generation/web/html.rs — HTML generation engine
component/web/body.rs — Body builder DSL
component/web/list.rs — List builder for unordered/ordered lists
component/web/table.rs — Table builder for structured data
component/web/span.rs — Span builder for inline formatting
*.page.rs — content library sources (in document/ subdirectories)
*.document.rs — thin binary entry points that invoke page libraries
Process
1. Discover
Documentation sources and build targets:
- Content libraries:
**/document/*.page.rs — each defines a pub fn page() returning page content
- Entry points:
*.document.rs — binary wrappers used by the document() Bazel rule
- Build targets: each entry point has a
document() rule in its BUILD.bazel
- Full site:
bazel build //:documentation assembles all pages into a folder
- Output:
.build/bazel/result/bin/documentation/
- Local preview:
bazel run //:distribute.documentation serves at http://127.0.0.1:3000
2. Analyze
For each documentation page, evaluate the .page.rs source and its rendered output:
Accuracy: Content matches implementation, paths exist, code examples compile, versions current
Beauty: Consistent use of the rendering framework, proper section hierarchy, visual coherence
Helpfulness: Clear explanations, practical examples, complete coverage, working links
Efficiency: Concise writing, scannable sections, no redundancy
To inspect rendered output:
- Build:
bazel build //:documentation
- Read:
.build/bazel/result/bin/documentation/{destination path}
3. Report
## Documentation Review
| File | Accuracy | Beauty | Helpful | Efficient |
|------|----------|--------|---------|-----------|
| path/index.html | PASS | WARN | PASS | PASS |
**Overall**: PASS/WARN/FAIL
## Findings
### [file]
**[Criterion]** [location]: Issue
**Fix**: Suggestion
## Missing Documentation
- [component/path] - Reason docs would help
Create documentation for any of these?
Non-Negotiable Violations
- Code examples that don't compile or match current API
- Broken links or nonexistent file paths
- Content that contradicts actual implementation behavior
- Missing navigation between related pages
- Outdated versions or removed features still documented
- Walls of text without section breaks