Chapter analyzer
Skill aiskillstore/marketplace/skills/abdulsamad94/chapter-analyzer
Validates and analyzes Docusaurus MDX chapters for structure, pedagogical quality, and component usage.From its SKILL.md
npx -y skills add aiskillstore/marketplace --skill chapter-analyzerAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
SKILL.md
1.3 KB, 311 tokens by cl100k_base, as published. Nobody here has run it
Chapter Analyzer Logic
Target Directory
- Location:
textbook/docs/ - Format: MDX (
.mdxor.md)
Structural Validation
Every chapter must have valid YAML frontmatter:
---
id: my-chapter-id
title: My Chapter Title
sidebar_label: Sidebar Label
description: Brief summary of the chapter.
---
Content Rules
- Heading Hierarchy:
- The Docusaurus title acts as H1.
- Start content with H2 (
##). - Do not use H1 (
#) within the body.
- Pedagogical Flow:
- Introduction: Hook the reader.
- Learning Objectives: Bullet points on what will be learned.
- Core Content: Explained with text + diagrams/code.
- Interactive Element: At least one Quiz or Simulation per major section.
- Summary: Recap key points.
Interactive Components
We use custom components in MDX:
<Quiz questions={[...]} />: For knowledge checks.<Simulation type="ros2-node" ... />: For embedded simulations.<Tabs>/<TabItem>: For multi-language code blocks (Python/C++).
Tone Check
- Voice: Encouraging, Authoritative but Accessible.
- Perspective: "We will learn", "Let's explore".
- Clarity: Avoid jargon without explanation.
What ships with it: 1 file
16.7 KB alongside SKILL.md
- skill-report.json16.7 KB