菜单
Use when documenting modules (libraries/addons) in create-faster MDX docs - covers standalone module pages with supported stacks, dependencies, env vars, and file structures
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/plvo/create-faster --skill documenting-module命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
正在显示 SKILL.md
基于 SOC 职业分类
| name | documenting-module |
| description | Use when documenting modules (libraries/addons) in create-faster MDX docs - covers standalone module pages with supported stacks, dependencies, env vars, and file structures |
Document what create-faster configures for each module. Focus on technical changes, not library features.
Core principle: Document OUR additions, link to THEIR docs. Each module gets its own standalone page.
Use when:
Do NOT use for:
documenting-stack skill)documenting-stack skill)Where things live:
META.libraries[name] in apps/cli/src/__meta__.tsapps/cli/templates/libraries/{library}/apps/www/content/docs/modules/{category}/{module}.mdxMETA.libraries[name].packageJson (NOT in templates)META.libraries[name].envs (NOT in templates)META.libraries[name].support.stacksMETA.libraries[name].requireMETA.libraries[name].monoPackage.json is programmatic. Dependencies are declared in META, not in template files.
Env vars are programmatic. Check envs fields in META, not template files.
---
title: Module Name
description: One-line description of what create-faster sets up for this module
---
## Presentation
Brief description of what you get (1-2 sentences).
[→ Official Documentation](https://...)
**Supported stacks:** Next.js, TanStack Start (list from META.support.stacks)
**Requirements:** ORM (Drizzle or Prisma) — only if META.require exists
## What create-faster adds
**Technical changes:**
Files added:
\`\`\`
src/
├── path/to/
│ └── file.tsx # Description
└── config.json # Description
# Turborepo only:
packages/name/
└── package.json # Description
\`\`\`
**Modified files:**
- `file.tsx` - What changed and why
**Dependencies:**
- List from META.libraries[name].packageJson.dependencies
- List from META.libraries[name].packageJson.devDependencies (as dev deps)
**Environment variables:** (only if META.libraries[name].envs exists)
- `VAR_NAME` - Purpose and scope
**Turborepo mode:**
How it behaves differently in monorepo (package name, imports, scope).
**Integration notes:**
How it works with ORM/database/other modules (only if relevant).
CRITICAL: META is the source of truth for dependencies, env vars, and support.
# Check module metadata in META
grep -A 30 "'modulename'" apps/cli/src/__meta__.ts
# Check supported stacks
grep -B 2 -A 5 "'modulename'" apps/cli/src/__meta__.ts | grep support
# Check requirements
grep -A 3 "'modulename'" apps/cli/src/__meta__.ts | grep require
# Check mono config
grep -A 3 "'modulename'" apps/cli/src/__meta__.ts | grep mono
# Check env vars
grep -A 10 "'modulename'" apps/cli/src/__meta__.ts | grep -A 5 envs
# Find all template files for module
ls -la apps/cli/templates/libraries/{modulename}/
# Check for frontmatter (only/mono filters)
grep -l '^---' apps/cli/templates/libraries/{modulename}/*.hbs
head -5 apps/cli/templates/libraries/{modulename}/*.hbs
# Check for stack-specific templates (.nextjs.hbs, .expo.hbs)
ls apps/cli/templates/libraries/{modulename}/*.*.hbs
Document EXACTLY what files we create/modify. Cross-reference every claim with actual template files AND META.
Frontmatter (YAML):
title: Module display name (from META.libraries[name].label)description: What create-faster sets up (NOT what the library does)CRITICAL - Don't add # Title:
Title in frontmatter already renders as H1. Adding # Title creates duplicate.
Document structure:
## Presentation - Brief description + link to official docs## What create-faster adds - Technical changesDO document:
apps/cli/templates/libraries/)packageJson.dependenciespackageJson.devDependenciesenvs fields (with scope)mono config and frontmatter only filters)appPackageJson dependencies (installed in the app, not the module package)exports from META packageJson.exports (package entry points)DON'T document:
MANDATORY verification before publishing:
# Verify dependencies exist in META
grep "'modulename'" -A 30 apps/cli/src/__meta__.ts | grep -A 10 packageJson
# Verify template files exist
ls apps/cli/templates/libraries/{modulename}/
# Verify supported stacks
grep "'modulename'" -A 10 apps/cli/src/__meta__.ts | grep stacks
# Verify env vars
grep "'modulename'" -A 20 apps/cli/src/__meta__.ts | grep -A 5 envs
Every dependency, env var, and file reference MUST be verified against the codebase.
Module pages live under apps/www/content/docs/modules/{category}/:
content/docs/modules/
├── meta.json # Folder config
├── ui/
│ ├── meta.json
│ ├── shadcn.mdx
│ ├── next-themes.mdx
│ └── nativewind.mdx
├── content/
│ ├── meta.json
│ ├── mdx.mdx
│ └── pwa.mdx
├── auth/
│ ├── meta.json
│ └── better-auth.mdx
├── api/
│ ├── meta.json
│ └── trpc.mdx
├── data-fetching/
│ ├── meta.json
│ ├── tanstack-query.mdx
│ └── tanstack-devtools.mdx
├── forms/
│ ├── meta.json
│ ├── react-hook-form.mdx
│ └── tanstack-form.mdx
└── deploy/
├── meta.json
└── aws-lambda.mdx
Each meta.json sets the folder title for the sidebar:
{
"title": "Category Name"
}
Categories match META.libraries[name].category values.
STOP if you write:
# Module Name title (title in frontmatter already renders as H1)| Mistake | Fix |
|---|---|
| Explaining library features | Link to official docs, focus on our additions |
| No file structure | Show tree with files created |
| Missing supported stacks | Check META.libraries[name].support.stacks |
| Unverified dependencies | Check META.libraries[name].packageJson |
| Missing turborepo differences | Check META mono config and frontmatter only filters |
| Putting module page in stack folder | Module pages go in modules/{category}/ |
| Forgetting appPackageJson | Some modules install deps in the app too (e.g., tRPC) |
| Excuse | Reality |
|---|---|
| "Need to explain what the library does" | Official docs exist. Link to them. |
| "Users need usage examples" | Official docs have tutorials. We document setup. |
| "Dependencies are obvious" | Verify against META. Old docs had errors. |
| "Single file, no tree needed" | Even one file gets a tree for consistency. |
| "Turborepo mode is the same" | Check mono config. Package creation differs. |
Frontmatter:
title: in YAML (don't add # Title after)description: describes what create-faster sets upDocument:
## Presentation with brief description## What create-faster adds sectionVerification (MANDATORY):
META.libraries[name].packageJsonapps/cli/templates/libraries/META.libraries[name].supportenvs fieldsrequire fieldsmono configUse when documenting blueprints in create-faster MDX docs - covers pre-composed starter projects with composition, architecture, application code, CLI usage, and extra dependencies
Use when creating a new blueprint for create-faster from scratch - covers META entry design, application template creation, and testing for complete starter projects
Use when extracting a working project into a create-faster blueprint - triggers on phrases like "turn my project into a blueprint", "extract blueprint from my CRM", "make this project a create-faster template"