Our review
This skill scaffolds, structures, and deploys a Docusaurus site for a Physical AI textbook, with book-aware content and RAG-ready exports.
Strengths
- Modular hierarchical structure tailored for course content
- Local search and Algolia DocSearch integration
- RAG-ready exports via frontmatter and semantic headings
- Automated CI/CD for GitHub Pages or Vercel deployment
Limitations
- Requires Node.js and basic Docusaurus knowledge
- Custom MDX components must be developed separately
- DocSearch setup requires an external Algolia key
Use this skill when you need to create a documentation site for a structured technical textbook with modules, weeks, and chapters, and want easy ingestion into RAG systems.
Do not use it for a simple landing page or blog without a deep hierarchy, or if you need an online CMS with live editing capabilities.
Security analysis
SafeThe skill instructs setting up a Docusaurus documentation site using standard tools (npx, npm) and writing content. There are no destructive commands, no exfiltration, and no obfuscation. All actions are typical of project scaffolding and deployment.
No concerns found
Examples
Set up a Docusaurus site for my Physical AI textbook with modules 1-4, a capstone, and a quarter overview. Configure sidebar, add MDX components for callouts and hardware tables, enable search, and set up GitHub Actions deployment to GitHub Pages.Create a new chapter for module 2 week 3 on sensor fusion. Write an MDX file with frontmatter including title, description, module=2, week=3, and tags. Follow the semantic heading structure (h2 for weeks, h3 for sections).List all markdown files under docs/ excluding build/ and static/. Output a glob pattern to feed into a RAG ingestion pipeline. Ensure each file has frontmatter fields title, description, module, week, tags.name: book-docusaurus description: Scaffold, structure, and deploy the Physical AI textbook in Docusaurus with book-aware content and RAG-ready exports. Use when creating or updating the Docusaurus site, adding chapters, configuring sidebar, or deploying to GitHub Pages/Vercel.
Book Docusaurus Skill
Instructions
-
Scaffold the site
- Ensure Node >=18 is installed
- Run
npx create-docusaurus@latest physical-ai-book classicin project root or/docs - Configure
docusaurus.config.jswith site metadata, GitHub Pages URLs, i18n (en default)
-
Structure content
- Build
sidebars.jsfor Quarter overview, Modules 1-4, Capstone, Assessments, Hardware kits, Cloud option - Create MDX stubs per module/week with learning outcomes and tasks
- Add capstone outline
- Build
-
Authoring affordances
- Add MDX components for callouts, checklists, hardware tables, code blocks
- Enable search (Algolia DocSearch placeholder) and local search plugin for dev
-
Deploy
- Add GitHub Actions workflow for GH Pages (
npm ci,npm run build,npm run deploy) - Document Vercel deploy steps (import repo, build command
npm run build, outputbuild)
- Add GitHub Actions workflow for GH Pages (
-
RAG-readiness
- Enforce frontmatter fields:
title,description,module,week,tags - Keep headings semantic (h2 for weeks, h3 for sections)
- Avoid heavy client-side rendering for core text
- Export ingestion guidance: markdown path glob, ignore build/static
- Enforce frontmatter fields:
Examples
# Create new chapter
mkdir -p docs/module-1/week-1
cat > docs/module-1/week-1/intro.mdx << 'EOF'
---
title: Introduction to Physical AI
description: Overview of embodied intelligence and humanoid robotics
module: 1
week: 1
tags: [physical-ai, robotics, introduction]
---
# Introduction to Physical AI
Content here...
EOF
# Build and test locally
npm run build
npm run serve
Definition of Done
npm run buildpasses; site renders outline and sample content- Sidebar matches course hierarchy; links valid
- GH Pages workflow present; deploy instructions written
- Content annotated with frontmatter and semantic headings suitable for chunking
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
Pivot Decision Framework
Documentation
Documents a strategic pivot or persevere decision with evidence, analysis, and rationale. Use when evaluating whether to change direction on a product, feature, or strategy based on market feedback.