review-doc

Audit BEEQ documentation pages against repository documentation rules.

160|24|Updated Feb 22, 2023
One-click install
npx skills add https://github.com/Endava/BEEQ --skill review-doc-endava
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-doc
Source: https://github.com/Endava/BEEQ/tree/main/.agents/skills/review-doc
Command: npx skills add https://github.com/Endava/BEEQ --skill review-doc-endava

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you review BEEQ documentation pages against the repository's writing, structure, accessibility, and source-accuracy rules so you can catch issues before publishing.

Core Features & Use Cases

  • Documentation Audits: Checks component and non-component MDX pages for the required sections, tone, and layout.
  • Source Verification: Compares docs against the component source, custom elements manifest, and related implementation files.
  • Migration Review: Supports temporary Zeroheight-to-Mintlify checks when a page was migrated and needs a cross-check.
  • Use Case: Use this Skill when a docs page needs a structured review for missing content, inaccurate API details, weak accessibility guidance, or inconsistent examples.

Quick Start

Review the selected BEEQ documentation page and return a prioritized list of issues with exact fixes.

Frequently Asked Questions about review-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit MDX documentation pages for structure and tone consistency?

You can audit MDX documentation pages for structure and tone consistency by validating required sections, layout rules, and writing style against repository standards to catch missing content before publishing.

How do I verify API accuracy in component documentation against source files?

Verifying API accuracy in component documentation requires comparing the docs against the component source code and custom elements manifest. This cross-reference ensures the documented properties and events match the actual implementation.

Can I check accessibility guidance and CodeLivePreview behavior in my docs review?

Yes, you can check accessibility guidance and CodeLivePreview behavior during a docs review. The audit validates interactive examples and ensures accessibility instructions meet the required documentation standards.

What is the best way to review migrated Zeroheight documentation pages?

The best way to review migrated Zeroheight documentation pages is to run a structured cross-check audit that validates framework tabs, image usage, and API accuracy to ensure nothing broke during the transition.

Does the documentation audit validate framework tabs and image usage?

Yes, the documentation audit validates framework tabs and image usage by checking that images are used correctly and framework tabs are properly configured to display the right code snippets.