review-doc
Skill162 starsChanged 14 days agoApache-2.0View on GitHub
Audit a BEEQ Mintlify MDX page (component or non-component) against the documentation guidelines and return a structured report: structure, code examples, source accuracy, tone and accessibility guidance. To write a page use doc-component.
7 other projects use a version of this.
Adopted by
Most recently taken up by
- angadhn/botferencetheir own version, first seen Nov 13, 2026
- koruworks/skillstheir own version, first seen Oct 15, 2026
- kohj1018/agentic-dev-harnesstheir own version, first seen Sep 29, 2026
- mekenthompson/ProductOStheir own version, first seen Jul 23, 2026
- tomharris/engineer-agenttheir own version, first seen Jul 22, 2026
- DGouron/review-flowtheir own version, first seen May 14, 2026
Other versions7 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 7
- DGouron/review-flow★ 44same name
- angadhn/botference★ 20same name
- kohj1018/agentic-dev-harness★ 2same name
- mekenthompson/ProductOS★ 1same name
- junhjang/claude-harness★ 0same name
- koruworks/skills★ 0same name
- tomharris/engineer-agent★ 0same name
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 repository10 other files it gives its agents.
- AGENTS.mdAGENTS.md
- create-componentSkill
- doc-componentSkill
- fix-accessibilitySkill
- pr-checklistSkill
- review-componentSkill
- write-e2e-testsSkill
- write-storiesSkill
- write-unit-testsSkill
- beeqSkill
The file
We split this skill into the rules it gives an agent
5 rules. 0 are common, 4 are distinctive, and 1 is very specific to this project.
0
Common
Most of the 6 edited versions we read keep these.
4
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 13
Before merging a new or changed MDX page in apps/beeq-docs/: component pages, or foundations, theming, setup, framework integrations and …
- Distinctive: line 14
When normalizing pages for consistency, or when a docs reviewer flags structure or tone issues.
- Distinctive: line 24
Read the documentation, component-docs and code-examples instructions in full.
- Distinctive: line 33
Read the full MDX file before running any checks.
- Distinctive: line 43
Check the page against every rule of each instruction section below.
“Common” is measured: kept by at least 6 in 10 of the 6 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
Review a BEEQ Documentation Page
When to Use
- Before merging a new or changed MDX page in apps/beeq-docs/: component pages, or foundations, theming, setup, framework integrations and usage guides.
- When normalizing pages for consistency, or when a docs reviewer flags structure or tone issues.
When NOT to Use
- For component code review use review-component.
- For writing a new page use doc-component.
1. Load the authoritative rules
Read the documentation, component-docs and code-examples instructions in full. They are the only source of rules; this skill adds no rules of its own.
2. Locate and read the files
$ARGUMENTSis a component name: readapps/beeq-docs/components/$ARGUMENTS.mdx.$ARGUMENTSis a path: read it directly.
Read the full MDX file before running any checks.
For a component page, read the component source to verify the API tables: packages/beeq/src/components/$ARGUMENTS/bq-$ARGUMENTS.tsx, scss/bq-$ARGUMENTS.variables.scss and the Custom Elements Manifest in packages/beeq/cem/.
For a non-component page, read the source that defines the documented behavior: Tailwind theme files, reset styles, global CSS variables, setup files or the snippets the page uses. Current repo source is canonical over older docs.
3. Audit
Check the page against every rule of each instruction section below. Record each violated rule with its location.
| Category | Rules to apply |
| Page structure | Component pages: page structure in component-docs (section order, optional sections, Resources last). Non-component pages: the non-component section in documentation, plus the checks below |
| Images | Image paths in component-docs; light and dark pair; overview and anatomy variants |
| When to use | When to Use and Related Components in component-docs; both siblings name each other with the deciding condition |
| CodeLivePreview isolation | CodeLivePreview in code-examples (mode, height, :host, previewRoot, IIFE, wrappers) |
| Framework tabs | CodeGroup in code-examples (tab order, icons, expandable, per-framework syntax) |
| CSS code tab | CSS Code Tab in code-examples |
| Best practices | Best Practices in component-docs |
| Accessibility | Accessibility in component-docs: keyboard table with one row per key, then a ### Rules table (Rule, Strength, Verified by) that covers the Accessibility bullets; no <Visibility for="agents"> rules block |
| Rule strength | Rule strength in documentation: capitals (MUST / SHOULD / MUST NOT / SHOULD NOT / MAY) appear only in the Rules and Invalid combinations Strength columns; Accessibility, Keyboard, prose and Do/Don't cards use plain lowercase wording |
| Allowed values | Allowed Values in component-docs: every variant, size, type or placement dimension lists its values as text |
| API reference | API Reference in component-docs, cross-checked against the source from step 2; Invalid combinations on every component page |
| Resources | Resources in component-docs |
| Tone & language | Tone and anti-patterns in documentation |
Additional checks for non-component pages:
- The introduction states what the page helps the reader understand or do.
- The page distinguishes what BEEQ ships from what it recommends or leaves to the consuming app, and never implies unavailable APIs, utilities, classes, tokens or components.
- Values, utilities, classes, tokens and setup steps match current source, and examples match the rendered
CodeLivePreview.
Additional check for every page: no documented prop, event, slot, part or CSS variable is absent from the source, and none in the source is missing from the docs.
Done when every row of the table has a status and every violation is listed.
4. Report format
## Documentation Review: [page]
### Summary
<1–2 sentence overall quality assessment and top priority items>
### Results
For non-component pages, mark component-only categories such as API reference or When to use as `N/A` unless the page intentionally includes them.
| Category | Status | Issues |
|---|---|---|
| Page structure | ✅/⚠️/❌ | … |
| Images | ✅/⚠️/❌ | … |
| When to use | ✅/⚠️/❌ | … |
| CodeLivePreview isolation | ✅/⚠️/❌ | … |
| Framework tabs | ✅/⚠️/❌ | … |
| CSS code tab | ✅/⚠️/❌ | … |
| Best practices | ✅/⚠️/❌ | … |
| Accessibility | ✅/⚠️/❌ | … |
| Rule strength | ✅/⚠️/❌ | … |
| Allowed values | ✅/⚠️/❌ | … |
| API reference | ✅/⚠️/❌ | … |
| Resources | ✅/⚠️/❌ | … |
| Tone & language | ✅/⚠️/❌ | … |
### Issues
For each problem:
- **Location** — section heading or approximate line, as a markdown link where possible
- **Severity** — `error` (missing required section or broken behavior) | `warning` (inconsistency) | `suggestion` (improvement)
- **Rule** — the specific guideline from the documentation instruction files
- **Fix** — the concrete, ready-to-apply changeExample invocations
/review-doc card
/review-doc apps/beeq-docs/components/dropdown.mdx
/review-doc apps/beeq-docs/foundations/grid.mdxDoes 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.

