docs-review
Skill6 starsChanged 14 days agoMITView on GitHub
Review Nacelle README, rustdoc, Markdown, mdBook navigation, commands, links, API contracts, and readiness wording against implementation and validation evidence.
25 other projects use a version of this.
Adopted by
Most recently taken up by
- mintlify/docstheir own version, first seen Nov 9, 2026
- langchain-ai/docstheir own version, first seen Nov 2, 2026
- mindroom-ai/mindroomtheir own version, first seen Nov 1, 2026
- NathanForster/claude-commandstheir own version, first seen Nov 1, 2026
- T0mSIlver/skillstheir own version, first seen Nov 1, 2026
- grimoire-rs/grimoiretheir own version, first seen Oct 27, 2026
Other versions25 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 25
- storybookjs/storybook★ 91ksame name
- metabase/metabase★ 50ksame name
- grafana/tempo★ 5.6ksame name
- graphistry/pygraphistry★ 2.6ksame name
- perber/leafwiki★ 1.2ksame name
- jtenniswood/espcontrol★ 1.2ksame name
- Harry-kp/vortix★ 757same name
- getsentry/sentry-rust★ 754same name
- mintlify/docs★ 465same name
- getsentry/sentry-docs★ 449same name
15 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository5 other files it gives its agents.
- .github/copilot-instructions.mdCopilot instructions
- code-reviewSkill
- nacelle-reviewSkill
- planningSkill
- pr-descriptionSkill
The file
We split this skill into the rules it gives an agent
9 rules. 0 are common, 7 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 24 edited versions we read keep these.
7
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Use this workflow for documentation-only changes and the documentation portion of mixed changes.
- Distinctive: line 14
Read the documentation instructions and general communication and documentation styles.
- Distinctive: line 22
Verify names, defaults, feature gates, errors, limits, and wire behavior.
- Distinctive: line 23
Check decoder progress and buffer ownership when codec documentation changes.
- Very specific: line 24
Verify commands from their stated working directory.
- Very specific: line 28
Check relative file links and heading anchors.
- Distinctive: line 30
Do not assume a successful render proves external links or commands work.
- Distinctive: line 31
Check that public API and behavior changes update the relevant crate README and reference pages.
- Distinctive: line 36
Keep correctness, security, performance, operability, compatibility, and documentation evidence distinct.
“Common” is measured: kept by at least 6 in 10 of the 24 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Reviewing Nacelle Documentation
Use this workflow for documentation-only changes and the documentation portion of mixed changes. Apply the general review evidence and severity rules without calling another review agent.
Procedure
- Read the documentation instructions and general communication and documentation styles.
- Identify the audience and contract: introductory use, tutorial, operator procedure, architecture explanation, or API/configuration reference. Keep working assessments and requested plans in their ignored locations.
- Compare claims with the owning crate, manifests, tests, examples, and scripts. Verify names, defaults, feature gates, errors, limits, and wire behavior. Check decoder progress and buffer ownership when codec documentation changes.
- Verify commands from their stated working directory. Confirm package names,
binary targets, flags, config paths, prerequisites, and supported TLS
combinations. Do not suggest workspace
--all-featureswhere it enables mutually exclusive providers. - Check relative file links and heading anchors. For published pages, trace
navigation from
docs/SUMMARY.mdand verify mdBook paths inbook.toml. Do not assume a successful render proves external links or commands work. - Check that public API and behavior changes update the relevant crate README and reference pages. Avoid duplicate authoritative descriptions that can diverge.
- Assess performance and readiness language against the stated platform, feature flags, workload, security mode, measurements, and rollback posture. Keep correctness, security, performance, operability, compatibility, and documentation evidence distinct. Do not import deployment requirements from another product or treat experimental status as a reason to omit safety contracts.
- Apply style to authored prose without changing identifiers, protocol tokens, quotations, or required technical details. Report consequential ambiguity or explicit rule violations, not subjective rewrites.
- Inspect or, when authorized, run
mdbook buildfor book changes. For rustdoc, assess owning-crate doc tests or the documentedcargo doccommand under the affected feature set. Report checks not run and unavailable tooling.
Output
Lead with verified findings: location, inaccurate or missing contract, affected reader or operation, evidence, and a concrete correction. Separate optional wording suggestions and unresolved evidence gaps from defects. If no verified findings remain, say so and state the validation scope.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

