Skills Guide

Livre Docusaurus

VérifiéSûr

Créez, structurez et déployez un site Docusaurus pour le manuel Physical AI. Cette compétence est utile pour initialiser le site de documentation du manuel, ajouter des chapitres, configurer la barre latérale ou déployer sur GitHub Pages ou Vercel. Elle impose également une structure de contenu adaptée au RAG avec des métadonnées et des titres sémantiques.

Spar Skills Guide Bot
DocumentationIntermédiaire
6002/06/2026
Claude CodeCursorWindsurf
#docusaurus#documentation-site#textbook#rag-ready

Recommandé pour

Claude CodeCursorDocumentation automatiqueWindsurf

Notre avis

Ce skill permet de créer, structurer et déployer un site Docusaurus pour un manuel de Physical AI, avec un contenu adapté à la consultation et à l'exportation pour RAG.

Points forts

  • Structure modulaire et hiérarchique adaptée aux cours
  • Intégration de la recherche locale et DocSearch
  • Export RAG prêt avec métadonnées et titres sémantiques
  • Déploiement automatisé sur GitHub Pages ou Vercel

Limites

  • Nécessite Node.js et une connaissance de base de Docusaurus
  • Les composants MDX personnalisés doivent être créés séparément
  • La configuration de DocSearch nécessite une clé Algolia externe
Quand l'utiliser

Utilisez ce skill lorsque vous devez mettre en place un site de documentation pour un manuel technique structuré en modules, semaines et chapitres, avec une exportation facile pour des systèmes RAG.

Quand l'éviter

Ne l'utilisez pas pour un simple site vitrine ou un blog sans structure hiérarchique complexe, ni si vous avez besoin d'un CMS avec édition en ligne.

Analyse de sécurité

Sûr
Score qualité93/100

The 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.

Aucun point d'attention détecté

Exemples

Scaffold and deploy a Physical AI textbook site
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.
Add a new chapter with RAG-ready metadata
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).
Export all content for RAG ingestion
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

  1. Scaffold the site

    • Ensure Node >=18 is installed
    • Run npx create-docusaurus@latest physical-ai-book classic in project root or /docs
    • Configure docusaurus.config.js with site metadata, GitHub Pages URLs, i18n (en default)

  2. Structure content

    • Build sidebars.js for 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

  3. Authoring affordances

    • Add MDX components for callouts, checklists, hardware tables, code blocks
    • Enable search (Algolia DocSearch placeholder) and local search plugin for dev

  4. 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, output build)

  5. 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

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 build passes; 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
Skills similaires

Generateur de Documentation API

Documentation

Genere automatiquement de la documentation API OpenAPI/Swagger.

Claude CodeCursorCopilotbeginner
340
98
1,287
Admin

Rédacteur Technique

Documentation

Rédige de la documentation technique claire selon les meilleurs style guides.

claudeCursorWindsurf+1intermediate
167
48
546
Admin

Système de formulaires de documentation typés

Documentation

Utilisez la syntaxe `(doc ...)` pour ajouter des annotations typées, des descriptions, des tâches (todo) et d'autres métadonnées directement dans le code Scheme. Les annotations sont extractibles via des commandes comme lf-todo et lf-types, et s'intègrent au vérificateur de types, où les déclarations de type dans les doc prennent le pas sur l'inférence. Idéal pour documenter les fonctions, marquer des déprécations ou lister des améliorations localisées sans recourir à un système externe.

Claude CodeintermediateSûr 95
0
0
19
Skills Guide Bot