codymaster 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +50 -0
- package/README.md +285 -0
- package/adapters/antigravity.js +15 -0
- package/adapters/claude-code.js +17 -0
- package/adapters/cursor.js +16 -0
- package/commands/bootstrap.md +49 -0
- package/commands/build.md +48 -0
- package/commands/content.md +48 -0
- package/commands/continuity.md +60 -0
- package/commands/debug.md +51 -0
- package/commands/demo.md +96 -0
- package/commands/deploy.md +51 -0
- package/commands/plan.md +42 -0
- package/commands/review.md +55 -0
- package/commands/track.md +46 -0
- package/commands/ux.md +46 -0
- package/dist/agent-dispatch.js +161 -0
- package/dist/chains/builtin.js +85 -0
- package/dist/continuity.js +385 -0
- package/dist/dashboard.js +926 -0
- package/dist/data.js +122 -0
- package/dist/index.js +2434 -0
- package/dist/judge.js +252 -0
- package/dist/parallel-dispatch.js +359 -0
- package/dist/parallel-quality.js +172 -0
- package/dist/skill-chain.js +258 -0
- package/install.sh +513 -0
- package/package.json +79 -0
- package/skills/.content-factory-state.json +132 -0
- package/skills/.git 2/logs/refs/heads/main +1 -0
- package/skills/.git 2/logs/refs/remotes/origin/main +1 -0
- package/skills/.git 2/objects/02/fb0956734b5f8ba3f918b7defd04a89cfe0076 +0 -0
- package/skills/.git 2/objects/08/1e129d75dc6feac6c02037272e6bd1a04e3324 +0 -0
- package/skills/.git 2/objects/0c/5393416f3c5e01c9a655a802bff0dd52f76f0a +0 -0
- package/skills/.git 2/objects/10/0b9be46978a946a77188f68be725098a122001 +0 -0
- package/skills/.git 2/objects/10/cf041167fc9843610eb3d90259ef3396315fdc +0 -0
- package/skills/.git 2/objects/12/5e19538dd6e1338ffe74f6c4c165b00435bf48 +0 -0
- package/skills/.git 2/objects/16/a9b9d0088d5c1347628b45a2620b479d8ad57c +0 -0
- package/skills/.git 2/objects/17/8c2a9ef93c33ae4eec9d58e82321f9229843a1 +0 -0
- package/skills/.git 2/objects/25/397ae41d09104d763bdcac2695209d85cdea89 +0 -0
- package/skills/.git 2/objects/2f/a836b7947f2d458e1f639788bf4bb0983a3305 +0 -0
- package/skills/.git 2/objects/3a/baaaf0a1c0909c0828335791557125fba911e0 +0 -0
- package/skills/.git 2/objects/42/2924221b81f5ce3c4e4daac9a64a24f9b01f9a +0 -0
- package/skills/.git 2/objects/42/ec0ce707447dc11446a34c9995fb8533801731 +0 -0
- package/skills/.git 2/objects/46/e43ce92866d56ce74b1d750db307cfe6154a15 +0 -0
- package/skills/.git 2/objects/48/5e41b633c63f55b8277bcc59f44f67681f671a +0 -0
- package/skills/.git 2/objects/49/49c596a3a89fa240642acd95dd3258e261eb09 +0 -0
- package/skills/.git 2/objects/50/9d42d8412ef8eaf7f7e138476bac2e4d10ce60 +0 -0
- package/skills/.git 2/objects/55/0c8c389d981b463ef849aeb792d8be3ccb6ec8 +0 -0
- package/skills/.git 2/objects/5d/82d3b18410cdda3ace3677436f0cb599dbe2d2 +0 -0
- package/skills/.git 2/objects/60/0617c58e871a38b33bf29e282d132bb3c381ad +0 -0
- package/skills/.git 2/objects/6a/8369a99c687b7245c92ffaf0e0f0dab9014504 +0 -0
- package/skills/.git 2/objects/79/bea435d40ab531c1aaf6be0432c6a5b7aaed21 +0 -0
- package/skills/.git 2/objects/7e/5ebd79251c2f14e4aceb86c74b6b6daae6b500 +0 -0
- package/skills/.git 2/objects/81/98a822a60178d6d5023ddb3e222cddf048742e +0 -0
- package/skills/.git 2/objects/86/0a0e1943dfe53411d2e499a1f16f46a96ef758 +0 -0
- package/skills/.git 2/objects/86/971fb55fdc081fdbae52376f0f13e57a4e9b04 +0 -0
- package/skills/.git 2/objects/88/b89dd609a0a03f8d4fe8bfde20d5b8fc1d326d +0 -0
- package/skills/.git 2/objects/90/8737edb6b7809e32cc01590b4e08ba42a9d40d +0 -0
- package/skills/.git 2/objects/93/d5a8a9a7d4fb7f11491cb596a6880528725118 +0 -0
- package/skills/.git 2/objects/98/46a2ab81d0c3b3eb00ef88fc56989aa7e9f316 +0 -0
- package/skills/.git 2/objects/9b/d8dd1e49cf274eaf9c555f3ab39dce7af5715e +0 -0
- package/skills/.git 2/objects/a1/13329fb0cec96ae78b222d33a24c3b5bc7fa1f +0 -0
- package/skills/.git 2/objects/a9/e6effe626e8a3aea3a8fc3364b492191c6e7d0 +0 -0
- package/skills/.git 2/objects/ad/6de7e48d9782cca9353d1ff0aa1aab7fe1df85 +0 -0
- package/skills/.git 2/objects/af/54ae316f771ff692e299ffcd8bf2f06b413b59 +0 -0
- package/skills/.git 2/objects/b0/4cb8b0b00dad633e731c1472161419e738d674 +0 -0
- package/skills/.git 2/objects/b3/094abb0b9ed46419b269e4a4e36a459690e3b0 +0 -0
- package/skills/.git 2/objects/b9/435c5d4baac2cfc5c83009ddd27b46b60db5f1 +0 -0
- package/skills/.git 2/objects/ba/5da17dbaec5ec2dcfdfd126aead518d1171d5c +0 -0
- package/skills/.git 2/objects/c0/bf58703aa258ba5dd63083bebaec8f223d844c +0 -0
- package/skills/.git 2/objects/c4/701a34edf1fc1bad58ccc57bd03f9426acb59a +0 -0
- package/skills/.git 2/objects/c7/5ccce9a4e5cc74d9b3174550cf6d993ca43638 +0 -0
- package/skills/.git 2/objects/c7/710d59b5a35b0f1f0a0399386643a0bd94c929 +0 -0
- package/skills/.git 2/objects/d1/fe58237112e953e5fec52da22cf38e08be3df9 +5 -0
- package/skills/.git 2/objects/d2/2bbe9fd2f74c95bc5583e803f5e435f1e2cd86 +0 -0
- package/skills/.git 2/objects/d7/e72852ea2bff74581dbf247d400120086229f4 +0 -0
- package/skills/.git 2/objects/d8/d4c3b5553e4fd72807e1d4b49ef07d9ef3ac35 +0 -0
- package/skills/.git 2/objects/dc/75050c2876f6a02ae2a53a3c886f395b622977 +0 -0
- package/skills/.git 2/objects/ee/e8546f95acec500187c08a28a8b9ee02db0dec +0 -0
- package/skills/.git 2/objects/ef/263c059208b416c2146434f10cb2b9fabcba16 +0 -0
- package/skills/.git 2/objects/f3/ae597e84d9a59b88acd21c99bde2eaf686d785 +0 -0
- package/skills/.git 2/objects/f3/f6f5673c821d3d8e76fa267a9e882e7a5387ea +0 -0
- package/skills/.git 2/objects/f9/6e6d0ad02624dd11d5848594d056caef7a5e8b +0 -0
- package/skills/.git 2/objects/ff/278988fc1edf0db3abcf18de795f4cc0b4f3e1 +0 -0
- package/skills/.git 2/refs/heads/main +1 -0
- package/skills/.git 2/refs/remotes/origin/main +1 -0
- package/skills/.pytest_cache 2/v/cache/nodeids +76 -0
- package/skills/.pytest_cache 2/v/cache/stepwise +1 -0
- package/skills/_shared/helpers.md +123 -0
- package/skills/_shared/outputs-convention.md +24 -0
- package/skills/cm-ads-tracker/SKILL.md +109 -0
- package/skills/cm-ads-tracker/evals/evals.json +55 -0
- package/skills/cm-ads-tracker/references/gtm-architecture.md +321 -0
- package/skills/cm-ads-tracker/references/industry-events.md +294 -0
- package/skills/cm-ads-tracker/references/platforms-api.md +238 -0
- package/skills/cm-ads-tracker/templates/capi-payload.md +79 -0
- package/skills/cm-ads-tracker/templates/datalayer-push.js +104 -0
- package/skills/cm-ads-tracker/templates/gtm-variables.js +56 -0
- package/skills/cm-brainstorm-idea/SKILL.md +423 -0
- package/skills/cm-code-review/SKILL.md +151 -0
- package/skills/cm-content-factory/SKILL.md +416 -0
- package/skills/cm-continuity/SKILL.md +399 -0
- package/skills/cm-dashboard/SKILL.md +533 -0
- package/skills/cm-dashboard/ui/app.js +1270 -0
- package/skills/cm-dashboard/ui/index.html +206 -0
- package/skills/cm-dashboard/ui/style.css +440 -0
- package/skills/cm-debugging/SKILL.md +412 -0
- package/skills/cm-deep-search/SKILL.md +242 -0
- package/skills/cm-design-system/SKILL.md +97 -0
- package/skills/cm-design-system/resources/halo-modern.md +40 -0
- package/skills/cm-design-system/resources/lunaris-advanced.md +40 -0
- package/skills/cm-design-system/resources/nitro-enterprise.md +39 -0
- package/skills/cm-design-system/resources/shadcn-default.md +37 -0
- package/skills/cm-dockit/README.md +100 -0
- package/skills/cm-dockit/SKILL.md +302 -0
- package/skills/cm-dockit/index.html +443 -0
- package/skills/cm-dockit/package-lock.json +1850 -0
- package/skills/cm-dockit/package.json +14 -0
- package/skills/cm-dockit/prompts/analysis.md +34 -0
- package/skills/cm-dockit/prompts/api-reference.md +24 -0
- package/skills/cm-dockit/prompts/architecture.md +21 -0
- package/skills/cm-dockit/prompts/data-flow.md +20 -0
- package/skills/cm-dockit/prompts/database.md +21 -0
- package/skills/cm-dockit/prompts/deployment.md +22 -0
- package/skills/cm-dockit/prompts/flows.md +21 -0
- package/skills/cm-dockit/prompts/jtbd.md +20 -0
- package/skills/cm-dockit/prompts/personas.md +24 -0
- package/skills/cm-dockit/prompts/sop-modules.md +40 -0
- package/skills/cm-dockit/scripts/doc-gen.sh +121 -0
- package/skills/cm-dockit/scripts/dockit-dashboard.sh +142 -0
- package/skills/cm-dockit/scripts/dockit-runner.sh +607 -0
- package/skills/cm-dockit/scripts/dockit-task.sh +166 -0
- package/skills/cm-dockit/skills/analyze-codebase.md +174 -0
- package/skills/cm-dockit/skills/api-reference.md +237 -0
- package/skills/cm-dockit/skills/changelog-guide.md +195 -0
- package/skills/cm-dockit/skills/content-guidelines.md +190 -0
- package/skills/cm-dockit/skills/sop-guide.md +184 -0
- package/skills/cm-dockit/skills/tech-docs.md +287 -0
- package/skills/cm-dockit/templates/markdown/structure.md +60 -0
- package/skills/cm-dockit/templates/vitepress-premium/.vitepress/config.mts +110 -0
- package/skills/cm-dockit/templates/vitepress-premium/.vitepress/theme/custom.css +189 -0
- package/skills/cm-dockit/templates/vitepress-premium/.vitepress/theme/index.ts +4 -0
- package/skills/cm-dockit/templates/vitepress-premium/package.json +19 -0
- package/skills/cm-dockit/templates/vitepress-premium/tests/frontend.test.ts +45 -0
- package/skills/cm-dockit/tests/runner.test.ts +66 -0
- package/skills/cm-dockit/workflows/export-markdown.md +82 -0
- package/skills/cm-dockit/workflows/generate-docs.md +68 -0
- package/skills/cm-dockit/workflows/setup-vitepress.md +181 -0
- package/skills/cm-example/SKILL.md +26 -0
- package/skills/cm-execution/SKILL.md +268 -0
- package/skills/cm-git-worktrees/SKILL.md +164 -0
- package/skills/cm-how-it-work/SKILL.md +189 -0
- package/skills/cm-identity-guard/SKILL.md +412 -0
- package/skills/cm-jtbd/SKILL.md +98 -0
- package/skills/cm-planning/SKILL.md +130 -0
- package/skills/cm-project-bootstrap/SKILL.md +161 -0
- package/skills/cm-project-bootstrap/templates/AGENTS.md +42 -0
- package/skills/cm-project-bootstrap/templates/frontend-safety.test.js +51 -0
- package/skills/cm-project-bootstrap/templates/i18n-sync.test.js +38 -0
- package/skills/cm-project-bootstrap/templates/pr-template.md +12 -0
- package/skills/cm-project-bootstrap/templates/project-identity.json +29 -0
- package/skills/cm-project-bootstrap/templates/vitest.config.js +10 -0
- package/skills/cm-quality-gate/SKILL.md +218 -0
- package/skills/cm-readit/SKILL.md +289 -0
- package/skills/cm-readit/audio-player.md +206 -0
- package/skills/cm-readit/examples/blog-reader.js +352 -0
- package/skills/cm-readit/examples/voice-cro.js +390 -0
- package/skills/cm-readit/tts-engine.md +262 -0
- package/skills/cm-readit/ui-patterns.md +362 -0
- package/skills/cm-readit/voice-cro.md +223 -0
- package/skills/cm-safe-deploy/SKILL.md +120 -0
- package/skills/cm-safe-deploy/templates/deploy.sh +89 -0
- package/skills/cm-safe-i18n/SKILL.md +473 -0
- package/skills/cm-secret-shield/SKILL.md +580 -0
- package/skills/cm-skill-chain/SKILL.md +78 -0
- package/skills/cm-skill-index/SKILL.md +318 -0
- package/skills/cm-skill-mastery/SKILL.md +169 -0
- package/skills/cm-start/SKILL.md +65 -0
- package/skills/cm-status/SKILL.md +12 -0
- package/skills/cm-tdd/SKILL.md +370 -0
- package/skills/cm-terminal/SKILL.md +177 -0
- package/skills/cm-test-gate/SKILL.md +242 -0
- package/skills/cm-ui-preview/SKILL.md +291 -0
- package/skills/cm-ux-master/DESIGN_STANDARD_TEMPLATE.md +54 -0
- package/skills/cm-ux-master/SKILL.md +114 -0
- package/skills/cro-methodology/SKILL.md +98 -0
- package/skills/cro-methodology/references/COPYWRITING.md +178 -0
- package/skills/cro-methodology/references/OBJECTIONS.md +135 -0
- package/skills/cro-methodology/references/PERSUASION.md +158 -0
- package/skills/cro-methodology/references/RESEARCH.md +220 -0
- package/skills/cro-methodology/references/funnel-analysis.md +365 -0
- package/skills/cro-methodology/references/testing-methodology.md +330 -0
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: cm-design-system
|
|
3
|
+
description: |
|
|
4
|
+
Ultimate Design System Intelligence. Manage, extract, replicate, and improve UI design systems.
|
|
5
|
+
Extracts design tokens visually from existing sites (Harvester v5), manages multi-page tokens, and utilizes MCP servers like Google Stitch and Pencil.dev to generate complete, consistent design systems (Shadcn UI, Halo, Lunaris, Nitro).
|
|
6
|
+
Use when the user asks to "extract design from a URL", "create a Shadcn design system", "analyze design tokens", "build a design system for", or "copy the UI style of".
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Goal
|
|
10
|
+
Establish a robust, stable, and consistent UI Design System by either extracting tokens from an existing source (Harvester mode) or scaffolding a fresh system based on premium Kits (Shadcn, Halo, Lunaris, Nitro). Output a strictly formatted `DESIGN.md` artifact ready for UI generation.
|
|
11
|
+
|
|
12
|
+
# Instructions
|
|
13
|
+
1. **Clarify Intent**: Determine if the user wants to *extract* an existing design from a URL/Image or *create* a new system from a specific UI Kit.
|
|
14
|
+
2. **Harvester Extraction (If applicable)**:
|
|
15
|
+
- Analyze the target visual source.
|
|
16
|
+
- Extract semantic colors (Primary, Secondary, Success, Warning, Danger), neutral ramps (50-900), typography scales, spacing tokens, and border radii.
|
|
17
|
+
3. **Pre-built UI Kits (Default Mode)**:
|
|
18
|
+
- If the user wants a beautiful design quickly, DO NOT try to generate tokens manually.
|
|
19
|
+
- Instead, copy one of the pre-built design systems from `skills/cm-design-system/resources/` into the project's `.stitch/DESIGN.md` or pass directly to `cm-ui-preview`:
|
|
20
|
+
- `shadcn-default.md` (Use this as the absolute DEFAULT if no style is specified)
|
|
21
|
+
- `halo-modern.md` (Premium dark mode, glowing accents)
|
|
22
|
+
- `lunaris-advanced.md` (Tech-focused, monospaced fonts)
|
|
23
|
+
- `nitro-enterprise.md` (High-contrast, data-dense enterprise)
|
|
24
|
+
4. **Pencil.dev & Google Stitch MCP**:
|
|
25
|
+
- **Stitch path:** Use `DESIGN.md` with `<!-- STITCH_TOKENS_START -->` JSON block to feed design tokens into Google Stitch's AI generator via `cm-ui-preview`.
|
|
26
|
+
- **Pencil path:** Use the Pencil MCP tools to create and manage `.pen` design files directly:
|
|
27
|
+
|
|
28
|
+
**Pencil.dev Workflow:**
|
|
29
|
+
```
|
|
30
|
+
1. open_document() → Create/open a .pen file
|
|
31
|
+
2. get_guidelines("web-app") → Load design rules for target platform
|
|
32
|
+
3. get_style_guide_tags() → Browse available style tags
|
|
33
|
+
4. get_style_guide(tags) → Get color palette, typography, spacing
|
|
34
|
+
5. set_variables() → Apply design tokens as .pen variables
|
|
35
|
+
6. batch_get(reusable:true)→ Read existing design system components
|
|
36
|
+
7. batch_design() → Insert/update components and screens
|
|
37
|
+
8. get_screenshot() → Verify visual output
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
**Mapping DESIGN.md tokens to .pen variables:**
|
|
41
|
+
```javascript
|
|
42
|
+
mcp_pencil_set_variables({
|
|
43
|
+
filePath: "design-system.pen",
|
|
44
|
+
variables: {
|
|
45
|
+
"primary": { "type": "color", "value": "#3B82F6" },
|
|
46
|
+
"secondary": { "type": "color", "value": "#10B981" },
|
|
47
|
+
"surface": { "type": "color", "value": "#FFFFFF" },
|
|
48
|
+
"text-primary": { "type": "color", "value": "#0F172A" },
|
|
49
|
+
"border-radius": { "type": "number", "value": 8 },
|
|
50
|
+
"spacing-sm": { "type": "number", "value": 8 },
|
|
51
|
+
"spacing-md": { "type": "number", "value": 16 },
|
|
52
|
+
"spacing-lg": { "type": "number", "value": 32 }
|
|
53
|
+
}
|
|
54
|
+
})
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
- For UI component rendering against these tokens, you MUST hand off to `cm-ui-preview`.
|
|
58
|
+
- **IMPORTANT:** Never use `view_file` or `grep_search` on `.pen` files. Always use `mcp_pencil_batch_get`.
|
|
59
|
+
5. **Export Custom `DESIGN.md` (Extraction Mode)**:
|
|
60
|
+
- If extracting from a site visually, create the `DESIGN.md` document.
|
|
61
|
+
- You MUST construct the exact JSON token block wrapped in `<!-- STITCH_TOKENS_START -->` and `<!-- STITCH_TOKENS_END -->`.
|
|
62
|
+
|
|
63
|
+
# Examples
|
|
64
|
+
|
|
65
|
+
## Example 1: Extract design from a URL
|
|
66
|
+
**Input:** "Can you extract the design system from stripe.com to use in our project?"
|
|
67
|
+
**Action:**
|
|
68
|
+
1. Extract semantic colors: Primary (Blurple), surface colors, typography (Inter), rounded corners.
|
|
69
|
+
2. Build the `DESIGN.md` including the Stitch STITCH_TOKENS JSON block with these tokens.
|
|
70
|
+
3. Tell the user: "Extraction complete. I've saved the tokens in `DESIGN.md`. Would you like me to hand this off to `cm-ui-preview` to generate components?"
|
|
71
|
+
|
|
72
|
+
## Example 2: Scaffold a new robust design system
|
|
73
|
+
**Input:** "Create a modern dark-mode design system using Halo UI kit."
|
|
74
|
+
**Action:**
|
|
75
|
+
1. Generate a premium deep-dark color palette.
|
|
76
|
+
2. Structure the tokens using Halo's spacing and glassmorphic shadow values.
|
|
77
|
+
3. Output `DESIGN.md` with STITCH_TOKENS.
|
|
78
|
+
4. Provide standard Tailwind config parameters matching the system.
|
|
79
|
+
|
|
80
|
+
## Example 3: Create a design system in Pencil.dev
|
|
81
|
+
**Input:** "Create a design system for our SaaS dashboard directly in Pencil.dev."
|
|
82
|
+
**Action:**
|
|
83
|
+
1. Open or create a `.pen` file: `mcp_pencil_open_document({ filePathOrTemplate: "new" })`.
|
|
84
|
+
2. Load design guidelines: `mcp_pencil_get_guidelines({ topic: "design-system" })`.
|
|
85
|
+
3. Browse and select a style guide: `mcp_pencil_get_style_guide_tags()` → `mcp_pencil_get_style_guide({ tags: ["saas", "dashboard", "modern", "website", "clean"] })`.
|
|
86
|
+
4. Apply design tokens via `mcp_pencil_set_variables()` using the style guide's recommendations.
|
|
87
|
+
5. Create reusable components (buttons, cards, inputs) via `mcp_pencil_batch_design()`.
|
|
88
|
+
6. Verify with `mcp_pencil_get_screenshot()`.
|
|
89
|
+
7. Tell the user: "Design system created in `design-system.pen`. Would you like me to build screens using these components?"
|
|
90
|
+
|
|
91
|
+
# Constraints
|
|
92
|
+
- 🚫 **DO NOT** generate or build React/Vue UI components directly in this skill. Handoff UI generation to `cm-ui-preview`.
|
|
93
|
+
- 🚫 **DO NOT** skip the `<!-- STITCH_TOKENS_START -->` wrapper in `DESIGN.md`. It is critical for Stitch MCP parsing.
|
|
94
|
+
- 🚫 **DO NOT** guess accessibility constraints — ensure text-on-background contrast aligns with WCAG AA (handled via `cm-ux-master` heuristics).
|
|
95
|
+
- 🚫 **DO NOT** use `view_file` or `grep_search` on `.pen` files. Always use Pencil MCP tools (`batch_get`, `batch_design`, etc.).
|
|
96
|
+
- ✅ **ALWAYS** define a complete neutral scale (50-900) even if the source site only uses a few grays.
|
|
97
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Halo Modern Design System
|
|
2
|
+
|
|
3
|
+
Use this template for premium consumer products, modern startup landing pages, and cutting-edge dashboards.
|
|
4
|
+
|
|
5
|
+
**Aesthetic:** Deep dark mode, vibrant glowing accents (purple/indigo), high contrast, glassmorphic shadows.
|
|
6
|
+
**Core values:** Slate-950 background, Indigo-500 primary, 0.75rem rounded corners.
|
|
7
|
+
|
|
8
|
+
<!-- STITCH_TOKENS_START -->
|
|
9
|
+
{
|
|
10
|
+
"theme": "dark",
|
|
11
|
+
"colors": {
|
|
12
|
+
"background": "#020617",
|
|
13
|
+
"foreground": "#f8fafc",
|
|
14
|
+
"card": "#0f172a",
|
|
15
|
+
"cardForeground": "#f8fafc",
|
|
16
|
+
"popover": "#0f172a",
|
|
17
|
+
"popoverForeground": "#f8fafc",
|
|
18
|
+
"primary": "#6366f1",
|
|
19
|
+
"primaryForeground": "#ffffff",
|
|
20
|
+
"secondary": "#1e293b",
|
|
21
|
+
"secondaryForeground": "#f8fafc",
|
|
22
|
+
"muted": "#1e293b",
|
|
23
|
+
"mutedForeground": "#94a3b8",
|
|
24
|
+
"accent": "#1e293b",
|
|
25
|
+
"accentForeground": "#f8fafc",
|
|
26
|
+
"destructive": "#f87171",
|
|
27
|
+
"destructiveForeground": "#000000",
|
|
28
|
+
"border": "#1e293b",
|
|
29
|
+
"input": "#1e293b",
|
|
30
|
+
"ring": "#6366f1"
|
|
31
|
+
},
|
|
32
|
+
"typography": {
|
|
33
|
+
"fontFamily": "Outfit, sans-serif"
|
|
34
|
+
},
|
|
35
|
+
"radius": "0.75rem",
|
|
36
|
+
"effects": {
|
|
37
|
+
"boxShadow": "0 0 15px rgba(99, 102, 241, 0.4)"
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
<!-- STITCH_TOKENS_END -->
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Lunaris Advanced Design System
|
|
2
|
+
|
|
3
|
+
Use this template for developer tools, crypto trading platforms, cybersecurity interfaces, and tech-heavy dashboards.
|
|
4
|
+
|
|
5
|
+
**Aesthetic:** Monospaced technical typography, deep space blues, neon cyan accents.
|
|
6
|
+
**Core values:** Slate-900 background, Cyan-400 primary, sharp corners (0.25rem).
|
|
7
|
+
|
|
8
|
+
<!-- STITCH_TOKENS_START -->
|
|
9
|
+
{
|
|
10
|
+
"theme": "dark",
|
|
11
|
+
"colors": {
|
|
12
|
+
"background": "#0b1121",
|
|
13
|
+
"foreground": "#e2e8f0",
|
|
14
|
+
"card": "#131e3a",
|
|
15
|
+
"cardForeground": "#e2e8f0",
|
|
16
|
+
"popover": "#131e3a",
|
|
17
|
+
"popoverForeground": "#e2e8f0",
|
|
18
|
+
"primary": "#22d3ee",
|
|
19
|
+
"primaryForeground": "#000000",
|
|
20
|
+
"secondary": "#1e293b",
|
|
21
|
+
"secondaryForeground": "#22d3ee",
|
|
22
|
+
"muted": "#0f172a",
|
|
23
|
+
"mutedForeground": "#64748b",
|
|
24
|
+
"accent": "#0f172a",
|
|
25
|
+
"accentForeground": "#22d3ee",
|
|
26
|
+
"destructive": "#ef4444",
|
|
27
|
+
"destructiveForeground": "#ffffff",
|
|
28
|
+
"border": "#1e293b",
|
|
29
|
+
"input": "#1e293b",
|
|
30
|
+
"ring": "#22d3ee"
|
|
31
|
+
},
|
|
32
|
+
"typography": {
|
|
33
|
+
"fontFamily": "JetBrains Mono, Roboto Mono, monospace"
|
|
34
|
+
},
|
|
35
|
+
"radius": "0.25rem",
|
|
36
|
+
"effects": {
|
|
37
|
+
"glow": "drop-shadow(0 0 8px rgba(34, 211, 238, 0.6))"
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
<!-- STITCH_TOKENS_END -->
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Nitro Enterprise Design System
|
|
2
|
+
|
|
3
|
+
Use this template for complex, data-dense enterprise applications, healthcare portals, and heavily structured B2B software.
|
|
4
|
+
|
|
5
|
+
**Aesthetic:** High contrast, information dense, robust neutral borders, distinct semantic colors.
|
|
6
|
+
**Core values:** White background, Royal Blue primary, strict gray borders, 0.375rem standard radius.
|
|
7
|
+
|
|
8
|
+
<!-- STITCH_TOKENS_START -->
|
|
9
|
+
{
|
|
10
|
+
"theme": "light",
|
|
11
|
+
"colors": {
|
|
12
|
+
"background": "#f8fafc",
|
|
13
|
+
"foreground": "#0f172a",
|
|
14
|
+
"card": "#ffffff",
|
|
15
|
+
"cardForeground": "#0f172a",
|
|
16
|
+
"popover": "#ffffff",
|
|
17
|
+
"popoverForeground": "#0f172a",
|
|
18
|
+
"primary": "#2563eb",
|
|
19
|
+
"primaryForeground": "#ffffff",
|
|
20
|
+
"secondary": "#e2e8f0",
|
|
21
|
+
"secondaryForeground": "#0f172a",
|
|
22
|
+
"muted": "#f1f5f9",
|
|
23
|
+
"mutedForeground": "#475569",
|
|
24
|
+
"accent": "#e0e7ff",
|
|
25
|
+
"accentForeground": "#1e40af",
|
|
26
|
+
"destructive": "#dc2626",
|
|
27
|
+
"destructiveForeground": "#ffffff",
|
|
28
|
+
"border": "#cbd5e1",
|
|
29
|
+
"input": "#cbd5e1",
|
|
30
|
+
"ring": "#2563eb",
|
|
31
|
+
"success": "#16a34a",
|
|
32
|
+
"warning": "#eab308"
|
|
33
|
+
},
|
|
34
|
+
"typography": {
|
|
35
|
+
"fontFamily": "Roboto, sans-serif"
|
|
36
|
+
},
|
|
37
|
+
"radius": "0.375rem"
|
|
38
|
+
}
|
|
39
|
+
<!-- STITCH_TOKENS_END -->
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Shadcn UI Default Design System
|
|
2
|
+
|
|
3
|
+
Use this template whenever a clean, minimalist, robust UI is requested, or when the user does not specify a specific framework.
|
|
4
|
+
|
|
5
|
+
**Aesthetic:** Clean, utilitarian, enterprise-grade, high legibility.
|
|
6
|
+
**Core values:** Slate neutrals, simple primary colors, 0.5rem standard radius.
|
|
7
|
+
|
|
8
|
+
<!-- STITCH_TOKENS_START -->
|
|
9
|
+
{
|
|
10
|
+
"theme": "light",
|
|
11
|
+
"colors": {
|
|
12
|
+
"background": "#ffffff",
|
|
13
|
+
"foreground": "#09090b",
|
|
14
|
+
"card": "#ffffff",
|
|
15
|
+
"cardForeground": "#09090b",
|
|
16
|
+
"popover": "#ffffff",
|
|
17
|
+
"popoverForeground": "#09090b",
|
|
18
|
+
"primary": "#09090b",
|
|
19
|
+
"primaryForeground": "#fafafa",
|
|
20
|
+
"secondary": "#f4f4f5",
|
|
21
|
+
"secondaryForeground": "#09090b",
|
|
22
|
+
"muted": "#f4f4f5",
|
|
23
|
+
"mutedForeground": "#71717a",
|
|
24
|
+
"accent": "#f4f4f5",
|
|
25
|
+
"accentForeground": "#09090b",
|
|
26
|
+
"destructive": "#ef4444",
|
|
27
|
+
"destructiveForeground": "#fafafa",
|
|
28
|
+
"border": "#e4e4e7",
|
|
29
|
+
"input": "#e4e4e7",
|
|
30
|
+
"ring": "#09090b"
|
|
31
|
+
},
|
|
32
|
+
"typography": {
|
|
33
|
+
"fontFamily": "Inter, sans-serif"
|
|
34
|
+
},
|
|
35
|
+
"radius": "0.5rem"
|
|
36
|
+
}
|
|
37
|
+
<!-- STITCH_TOKENS_END -->
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# 📚 Doc-Kit for Google Antigravity
|
|
2
|
+
|
|
3
|
+
[](https://github.com/your-repo/doc-kit)
|
|
4
|
+
[](https://vitepress.dev/)
|
|
5
|
+
[](https://en.wikipedia.org/wiki/Markdown)
|
|
6
|
+
|
|
7
|
+
A professional documentation generation toolkit built for **Google Antigravity**. Skip the manual documentation effort and instantly turn your codebase into beautiful, structured, and deployable documentation.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 🚀 The Problem We Solve
|
|
12
|
+
|
|
13
|
+
Writing documentation is tedious. Keeping it updated is even harder.
|
|
14
|
+
**Doc-Kit** empowers your AI agent to independently read your code, trace logic, map architectures, and write documentation that developers and end-users will actually love to read.
|
|
15
|
+
|
|
16
|
+
## ✨ Core Features
|
|
17
|
+
|
|
18
|
+
* **🧠 Deep Codebase Analysis:** Traces real code paths, not just file names.
|
|
19
|
+
* **📐 Technical Documentation:** Generates System Architecture, Data Flows, and Database Schemas with dark-mode Mermaids.
|
|
20
|
+
* **📋 SOP User Guides:** Creates step-by-step Standard Operating Procedures (SOPs) for non-technical users.
|
|
21
|
+
* **🔌 API Reference:** Automatically extracts endpoints, request/response schemas, and builds cURL/JS examples.
|
|
22
|
+
* **🎨 Dual Output Formats:**
|
|
23
|
+
* **Markdown:** Clean, portable `.md` files structured perfectly for any repo.
|
|
24
|
+
* **VitePress:** Instantly scaffolds a fully-featured static site with built-in Mermaid, search, and dark mode — ready to deploy.
|
|
25
|
+
|
|
26
|
+
## 🛠 Installation
|
|
27
|
+
|
|
28
|
+
Simply copy the `doc-kit` folder into your Antigravity skills directory:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
cp -r cm-dockit ~/.gemini/antigravity/skills/
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Make sure the CLI script is executable:
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
chmod +x ~/.gemini/antigravity/skills/cm-dockit/scripts/doc-gen.sh
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## 💻 Quick Start
|
|
41
|
+
|
|
42
|
+
### The Interactive CLI
|
|
43
|
+
|
|
44
|
+
To get the best results effortlessly, use the built-in CLI menu:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
bash ~/.gemini/antigravity/skills/cm-dockit/scripts/doc-gen.sh
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
The CLI will ask you 4 quick questions:
|
|
51
|
+
1. **Document Type:** Technical, SOP, API, or All.
|
|
52
|
+
2. **Output Format:** Plain Markdown or VitePress.
|
|
53
|
+
3. **Source Code Path:** Which project do you want to document?
|
|
54
|
+
4. **Language:** English or Vietnamese.
|
|
55
|
+
|
|
56
|
+
It instantly generates an optimized prompt and copies it to your clipboard. Just paste it into your Google Antigravity session!
|
|
57
|
+
|
|
58
|
+
### Direct Trigger
|
|
59
|
+
|
|
60
|
+
Alternatively, simply type in your Antigravity session:
|
|
61
|
+
|
|
62
|
+
> "Use doc-kit to create documentation for the project at /path/to/my/project"
|
|
63
|
+
|
|
64
|
+
The agent will prompt you for the required choices.
|
|
65
|
+
|
|
66
|
+
## 📂 Architecture of Doc-Kit
|
|
67
|
+
|
|
68
|
+
Doc-Kit is built using specialized sub-skills for maximum depth and accuracy:
|
|
69
|
+
|
|
70
|
+
```text
|
|
71
|
+
skills/cm-dockit/
|
|
72
|
+
├── SKILL.md # Main orchestration agent
|
|
73
|
+
├── scripts/
|
|
74
|
+
│ ├── doc-gen.sh # Interactive CLI
|
|
75
|
+
│ ├── dockit-runner.sh # DAG-based task execution
|
|
76
|
+
│ ├── dockit-dashboard.sh # Progress dashboard
|
|
77
|
+
│ └── dockit-task.sh # Individual task runner
|
|
78
|
+
├── skills/
|
|
79
|
+
│ ├── analyze-codebase.md # Semantic analysis
|
|
80
|
+
│ ├── tech-docs.md # System Architecture
|
|
81
|
+
│ ├── sop-guide.md # Step-by-step UX flows
|
|
82
|
+
│ ├── api-reference.md # Auto REST/GraphQL extraction
|
|
83
|
+
│ └── content-guidelines.md # Content formatting rules
|
|
84
|
+
├── templates/ # Output format templates
|
|
85
|
+
│ ├── markdown/
|
|
86
|
+
│ └── vitepress-premium/
|
|
87
|
+
├── tests/
|
|
88
|
+
│ └── runner.test.ts # Backend test suite
|
|
89
|
+
└── workflows/ # Rules for output (Markdown or VitePress)
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## 🛡 Verification Standard
|
|
93
|
+
|
|
94
|
+
Doc-Kit enforces **zero-tolerance for shallow analysis**:
|
|
95
|
+
1. **Every claim cited:** Documentation cites `(file_path:line_number)`.
|
|
96
|
+
2. **Visual architecture:** Requires minimum 2 dark-theme Mermaid diagrams per technical file.
|
|
97
|
+
3. **No Hand-Waving:** If the AI hasn't traced the code, it explicitly states "Requires further inspection".
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
*Elevate your codebase with documentation that writes itself.*
|
|
@@ -0,0 +1,302 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: cm-dockit
|
|
3
|
+
description: "Knowledge systematization engine — analyze codebases, generate Personas, JTBD, Process Flows, technical docs, SOP user guides, API references. Output as Markdown or VitePress Premium. SEO-optimized, AI/LLM-readable. One scan = complete knowledge base."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# CM DocKit: Knowledge Systematization Engine
|
|
7
|
+
|
|
8
|
+
A professional knowledge systematization engine powered by codebase analysis and UX design principles. **One source scan = one complete knowledge base** — Personas, JTBD, Process Flows, Technical Docs, SOPs, API Reference. Supports plain Markdown output or a premium VitePress site. Includes SEO optimization, sitemap generation, and AI/LLM-readable content.
|
|
9
|
+
|
|
10
|
+
## When to Activate
|
|
11
|
+
|
|
12
|
+
- User asks to "create documentation", "generate docs"
|
|
13
|
+
- User mentions "SOP", "user guide", "manual"
|
|
14
|
+
- User wants technical docs from a codebase
|
|
15
|
+
- User mentions "changelog", "release notes", "version history"
|
|
16
|
+
- User runs `/DocKit Master`
|
|
17
|
+
|
|
18
|
+
## Document Types
|
|
19
|
+
|
|
20
|
+
| Type | Skill File | Description |
|
|
21
|
+
|------|-----------|-------------|
|
|
22
|
+
| **knowledge** | *(generated directly by AI agent)* | Personas, JTBD, Process Flows — knowledge foundation |
|
|
23
|
+
| **tech** | `skills/tech-docs.md` | Architecture, database, deployment, data flow |
|
|
24
|
+
| **sop** | `skills/sop-guide.md` | Step-by-step user guides (enriched with knowledge) |
|
|
25
|
+
| **api** | `skills/api-reference.md` | API endpoint reference with examples |
|
|
26
|
+
| **changelog** | `skills/changelog-guide.md` | Release notes & version history (🚀 Improvements / 🐛 Bug Fixes) |
|
|
27
|
+
| **all** | All above | Full knowledge base + documentation suite |
|
|
28
|
+
|
|
29
|
+
| Support Skill | Purpose |
|
|
30
|
+
|--------------|--------|
|
|
31
|
+
| **SEO Checklist** | Per-page SEO audit (title, meta, headings, robots) — applied inline by AI agent |
|
|
32
|
+
| **Content Writing** | SEO copywriting, keywords, active voice, FAQ — applied inline by AI agent |
|
|
33
|
+
| **LLM Optimization** | AI-readable structure, NotebookLM-friendly — applied inline by AI agent |
|
|
34
|
+
|
|
35
|
+
## Output Formats
|
|
36
|
+
|
|
37
|
+
| Format | Workflow | Description |
|
|
38
|
+
|--------|---------|-------------|
|
|
39
|
+
| **markdown** | `workflows/export-markdown.md` | Plain `.md` files in `docs/` folder |
|
|
40
|
+
| **vitepress** | `workflows/setup-vitepress.md` | Premium VitePress static site (**default**) — built-in Mermaid, search, dark mode |
|
|
41
|
+
|
|
42
|
+
## Procedure
|
|
43
|
+
|
|
44
|
+
### Step 1: Gather Input (Single Consolidated Prompt)
|
|
45
|
+
|
|
46
|
+
**CRITICAL:** Ask ALL questions in ONE message. Do NOT ask one at a time.
|
|
47
|
+
Present the following intake form to the user, using this **📚 DocKit Master — Configuration**
|
|
48
|
+
|
|
49
|
+
Please answer the following questions so I can automatically create an execution plan:
|
|
50
|
+
|
|
51
|
+
| # | Question | Options | Default |
|
|
52
|
+
|---|---------|---------|--------|
|
|
53
|
+
| 1 | **📑 Document type?** | `knowledge` · `tech` · `sop` · `api` · `changelog` · `all` | `all` |
|
|
54
|
+
| 2 | **🎨 Output format?** | `markdown` (plain) · `vitepress` (premium site) | `vitepress` |
|
|
55
|
+
| 3 | **📂 Code scan scope?** | `full` (entire project) · `focused` (specific folder/feature) | `full` |
|
|
56
|
+
| 4 | **🎯 Focus area?** *(only if `focused`)* | Folder name, module, or specific feature | — |
|
|
57
|
+
| 5 | **🌏 Writing language?** | Auto-detect from chat language *(see below)* | auto-detect |
|
|
58
|
+
| 6 | **🌐 Add multi-language?** | `yes` (add English + source language) · `no` | `no` |
|
|
59
|
+
| 7 | **📹 Record video demo?** | `yes` (record browser walkthrough) · `no` | `no` |
|
|
60
|
+
| 8 | **📁 Project path?** | *(absolute path)* | current workspace |
|
|
61
|
+
| 9 | **🔍 SEO optimization?** | `yes` (SEO frontmatter + checklist + sitemap) · `no` | `yes` |
|
|
62
|
+
| 10 | **🤖 Optimize for AI/LLM?** | `yes` (AI-readable + NotebookLM sitemap) · `no` | `yes` |
|
|
63
|
+
|
|
64
|
+
*You can answer briefly, e.g.: "all, vitepress, full, yes, no, yes, yes"*
|
|
65
|
+
|
|
66
|
+
**🌏 Smart language rules:**
|
|
67
|
+
|
|
68
|
+
1. **Auto-detect**: Determine default language from the user's chat language
|
|
69
|
+
- User chats in Vietnamese → default `vi`
|
|
70
|
+
- User chats in Chinese → default `zh`
|
|
71
|
+
- User chats in Japanese → default `ja`
|
|
72
|
+
- User chats in English → default `en`
|
|
73
|
+
- *(Applies similarly for any other language)*
|
|
74
|
+
2. **Multi-language (`yes`)**: Automatically add English (`en`) as secondary language
|
|
75
|
+
- Example: Vietnamese user + multi-language → `vi` + `en`
|
|
76
|
+
- Example: Chinese user + multi-language → `zh` + `en`
|
|
77
|
+
- If user already chats in English + multi-language → ask which secondary language
|
|
78
|
+
3. **Override**: User can override by specifying explicitly, e.g.: \"write in Japanese\"
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
### Step 1b: Auto-Generate Execution Plan
|
|
83
|
+
|
|
84
|
+
After receiving answers, **immediately create an execution plan** (do NOT ask more questions).
|
|
85
|
+
|
|
86
|
+
Map the answers to this execution config:
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
DOC_TYPE = [knowledge | tech | sop | api | changelog | all]
|
|
90
|
+
FORMAT = [markdown | vitepress]
|
|
91
|
+
SCOPE = [full | focused]
|
|
92
|
+
FOCUS_TARGET = [directory/module name if focused, else null]
|
|
93
|
+
LANGUAGE = [vi | en | vi+en]
|
|
94
|
+
I18N = [yes | no] (only relevant for vitepress)
|
|
95
|
+
RECORD = [yes | no]
|
|
96
|
+
PROJECT_PATH = [absolute path]
|
|
97
|
+
SEO = [yes | no] (default: yes)
|
|
98
|
+
LLM_OPTIMIZE = [yes | no] (default: yes)
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Then present the plan to user as a checklist artifact, like:
|
|
102
|
+
|
|
103
|
+
```markdown
|
|
104
|
+
## 🚀 Execution Plan
|
|
105
|
+
|
|
106
|
+
- [ ] Scan code: [full/focused → target]
|
|
107
|
+
- [ ] Generate documents: [type] in [language]
|
|
108
|
+
- [ ] Export format: [markdown/vitepress]
|
|
109
|
+
- [ ] [If vitepress + i18n] Configure multi-language
|
|
110
|
+
- [ ] [If record] Record video walkthrough
|
|
111
|
+
- [ ] [If seo] Run SEO checklist + generate sitemap
|
|
112
|
+
- [ ] [If llm_optimize] Apply LLM optimization rules
|
|
113
|
+
- [ ] Review and deliver
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
**After presenting the plan → proceed to Step 2 immediately (auto-execute).**
|
|
117
|
+
Do NOT wait for approval unless the plan has ambiguity.
|
|
118
|
+
|
|
119
|
+
### Step 2: Analyze Codebase
|
|
120
|
+
|
|
121
|
+
Read and follow `skills/analyze-codebase.md` in this directory.
|
|
122
|
+
|
|
123
|
+
Output: structured analysis saved to `docs/analysis.md` (NOT `_analysis.md`) including:
|
|
124
|
+
- Project type, languages, frameworks
|
|
125
|
+
- Directory structure and architecture layers
|
|
126
|
+
- Entry points, routes, database schema
|
|
127
|
+
- Key business logic modules
|
|
128
|
+
- Dependencies overview
|
|
129
|
+
- Test coverage
|
|
130
|
+
|
|
131
|
+
### Step 3: Apply Content Guidelines
|
|
132
|
+
|
|
133
|
+
**MANDATORY** — Read `skills/content-guidelines.md` before generating any content.
|
|
134
|
+
|
|
135
|
+
Key rules to enforce:
|
|
136
|
+
- **Filenames**: kebab-case, no underscores, no dots
|
|
137
|
+
- **Frontmatter**: Every `.md` file must have `title`, `description`, `keywords`, `robots`
|
|
138
|
+
- **Quick Reference**: Every doc starts with a summary box
|
|
139
|
+
- **Progressive Disclosure**: Use `<details>` for advanced content
|
|
140
|
+
- **Admonitions**: Use `:::tip`, `:::info`, `:::warning`, `:::danger` for callouts
|
|
141
|
+
- **Mermaid**: NO hardcoded colors — VitePress auto-adapts to light/dark
|
|
142
|
+
- **Code Groups**: Use `:::code-group` for multi-platform examples
|
|
143
|
+
- **Internal Links**: ≥2 cross-links per page
|
|
144
|
+
|
|
145
|
+
### Step 3b: Apply SEO & LLM Guidelines (If enabled)
|
|
146
|
+
|
|
147
|
+
**If SEO = yes:** Apply these SEO content writing guidelines directly:
|
|
148
|
+
- Keyword placement (title, H1, first paragraph, H2s, meta)
|
|
149
|
+
- Inverted pyramid structure (answer first, details later)
|
|
150
|
+
- Active voice (≥80%), transition words (≥30%)
|
|
151
|
+
- FAQ in schema-ready format for rich snippets
|
|
152
|
+
|
|
153
|
+
**If LLM_OPTIMIZE = yes:** Apply these AI-readability guidelines directly:
|
|
154
|
+
- Clean heading hierarchy (no skipped levels)
|
|
155
|
+
- Text descriptions alongside all Mermaid diagrams
|
|
156
|
+
- Self-contained sections (≤500 words per H2)
|
|
157
|
+
- Consistent terminology (glossary section in index)
|
|
158
|
+
- UTF-8 clean output
|
|
159
|
+
|
|
160
|
+
### Step 4: Generate Documents
|
|
161
|
+
|
|
162
|
+
Based on the chosen type, read and follow the corresponding skill file:
|
|
163
|
+
|
|
164
|
+
- **knowledge** → AI agent generates directly:
|
|
165
|
+
1. `docs/personas/` (Buyer & User Personas)
|
|
166
|
+
2. `docs/jtbd/` (JTBD Canvases)
|
|
167
|
+
3. `docs/flows/` (Workflow, Sequence, Lifecycle, Journey)
|
|
168
|
+
|
|
169
|
+
- **tech** → Read `skills/tech-docs.md`, generate:
|
|
170
|
+
- `docs/architecture.md` — System architecture + ADR
|
|
171
|
+
- `docs/database.md` — Database schema & data model
|
|
172
|
+
- `docs/deployment.md` — Deployment & infrastructure
|
|
173
|
+
- `docs/data-flow.md` — Data flow diagrams
|
|
174
|
+
|
|
175
|
+
- **sop** → **Auto-run `knowledge` first if not yet generated**, then:
|
|
176
|
+
- Read `skills/sop-guide.md`, generate:
|
|
177
|
+
- `docs/sop/` — One `.md` per feature/module
|
|
178
|
+
- Each file: Persona Context → Process Flow → Steps → Journey → Troubleshooting → FAQ
|
|
179
|
+
|
|
180
|
+
- **api** → Read `skills/api-reference.md`, generate:
|
|
181
|
+
- `docs/api/` — Organized by resource
|
|
182
|
+
- Each file: Quick Ref → Endpoints table → Multi-language examples
|
|
183
|
+
|
|
184
|
+
- **changelog** → Read `skills/changelog-guide.md`, generate:
|
|
185
|
+
- `docs/changelog.md` — Full release history with 2 categories:
|
|
186
|
+
- 🚀 **Improvements** — features, enhancements, refactors
|
|
187
|
+
- 🐛 **Bug Fixes** — fixes, patches, corrections
|
|
188
|
+
- Reads from `CHANGELOG.md` at project root (generated by `cm-safe-deploy` Gate 8)
|
|
189
|
+
- If `CHANGELOG.md` doesn't exist, generates from git tags/history
|
|
190
|
+
|
|
191
|
+
- **all** → Run `knowledge` → `tech` → `sop` → `api` → `changelog` sequentially
|
|
192
|
+
|
|
193
|
+
### Step 5: Export
|
|
194
|
+
|
|
195
|
+
Based on the chosen format, read and follow the corresponding workflow:
|
|
196
|
+
|
|
197
|
+
- **markdown** → Read `workflows/export-markdown.md`
|
|
198
|
+
- Create `docs/README.md` as index
|
|
199
|
+
- Organize into clean folder structure
|
|
200
|
+
|
|
201
|
+
- **vitepress** → Read `workflows/setup-vitepress.md`
|
|
202
|
+
- Scaffold VitePress with premium template
|
|
203
|
+
- Auto-sidebar from folder structure
|
|
204
|
+
- Built-in Mermaid, search, dark mode
|
|
205
|
+
- Build and verify
|
|
206
|
+
|
|
207
|
+
### Step 5b: Generate Sitemap (If SEO = yes)
|
|
208
|
+
|
|
209
|
+
Read and follow `workflows/generate-sitemap.md`:
|
|
210
|
+
|
|
211
|
+
- **VitePress**: Sitemap auto-generated via `sitemap` config option. Generate `robots.txt`, extract `sitemap-urls.txt`
|
|
212
|
+
- **Markdown**: Generate `docs/sitemap.md` (link index) + `docs/sitemap-urls.txt`
|
|
213
|
+
- Both formats produce a **NotebookLM-ready URL list** for AI research
|
|
214
|
+
|
|
215
|
+
### Step 5c: Run SEO Audit (If SEO = yes)
|
|
216
|
+
|
|
217
|
+
Read `skills/content-guidelines.md` SEO checklist section and audit every generated page:
|
|
218
|
+
- Title (50–60 chars, keyword) ✔️
|
|
219
|
+
- Meta description (150–160 chars) ✔️
|
|
220
|
+
- Single H1, no skipped levels ✔️
|
|
221
|
+
- ≥2 internal links ✔️
|
|
222
|
+
- Robots directive set ✔️
|
|
223
|
+
- All images have alt text ✔️
|
|
224
|
+
|
|
225
|
+
### Step 6: Summary
|
|
226
|
+
|
|
227
|
+
Present to user:
|
|
228
|
+
- List of generated files with sizes
|
|
229
|
+
- How to view/serve the docs
|
|
230
|
+
- Next steps (customize, deploy, etc.)
|
|
231
|
+
|
|
232
|
+
**If generated docs > 30 files**, also suggest:
|
|
233
|
+
|
|
234
|
+
```markdown
|
|
235
|
+
💡 **Pro Tip: Deep Search**
|
|
236
|
+
|
|
237
|
+
The documentation set just created has [X] files. You can index them using
|
|
238
|
+
[qmd](https://github.com/tobi/qmd) for semantic search by AI
|
|
239
|
+
across all future sessions:
|
|
240
|
+
|
|
241
|
+
\`\`\`bash
|
|
242
|
+
npm install -g @tobilu/qmd
|
|
243
|
+
qmd collection add ./docs --name project-docs
|
|
244
|
+
qmd context add qmd://project-docs "Project documentation for [project-name]"
|
|
245
|
+
qmd embed
|
|
246
|
+
\`\`\`
|
|
247
|
+
|
|
248
|
+
See also: `cm-deep-search` skill.
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
## CLI Quick Start
|
|
252
|
+
|
|
253
|
+
For a fast interactive experience, use the built-in CLI scripts:
|
|
254
|
+
|
|
255
|
+
```bash
|
|
256
|
+
# Main documentation generator
|
|
257
|
+
bash scripts/doc-gen.sh
|
|
258
|
+
|
|
259
|
+
# Full runner with DAG-based task execution
|
|
260
|
+
bash scripts/dockit-runner.sh -p /path/to/project -t all
|
|
261
|
+
|
|
262
|
+
# Dashboard view of progress
|
|
263
|
+
bash scripts/dockit-dashboard.sh
|
|
264
|
+
|
|
265
|
+
# Individual task runner
|
|
266
|
+
bash scripts/dockit-task.sh
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
> Run these scripts from the `cm-dockit` skill directory.
|
|
270
|
+
|
|
271
|
+
## UX Principles Applied
|
|
272
|
+
|
|
273
|
+
| UX Law | Application |
|
|
274
|
+
|--------|-------------|
|
|
275
|
+
| **Hick's Law** | ≤7 TOC items, progressive disclosure for advanced content |
|
|
276
|
+
| **Miller's Law** | Information chunked into groups of 5-9 |
|
|
277
|
+
| **Doherty Threshold** | Tables for structured data, scannable summaries |
|
|
278
|
+
| **Jakob's Law** | Standard doc layout (sidebar + content + TOC) |
|
|
279
|
+
| **Fitts's Law** | Touch-friendly navbar links (≥44px) |
|
|
280
|
+
| **WCAG 2.1 AA** | Focus-visible rings, high contrast, reduced motion |
|
|
281
|
+
|
|
282
|
+
## Constraints
|
|
283
|
+
|
|
284
|
+
- All Mermaid diagrams use NO hardcoded inline styles — VitePress theming handles light/dark
|
|
285
|
+
- Every technical claim cites `(file_path:line_number)`
|
|
286
|
+
- SOP docs use `<details>` for troubleshooting (progressive disclosure)
|
|
287
|
+
- All generated files include YAML frontmatter with `title`, `description`
|
|
288
|
+
- **Pure Markdown** — no MDX, no special escaping needed
|
|
289
|
+
- **No underscore-prefixed filenames** — breaks auto-sidebar detection
|
|
290
|
+
- VitePress output must pass `npx vitepress build` without errors
|
|
291
|
+
- **SEO default**: `robots: "index, follow"` unless page is internal/draft
|
|
292
|
+
- **≥2 internal links** per page (never orphan pages)
|
|
293
|
+
- **Text fallback** for every Mermaid diagram (LLM readability)
|
|
294
|
+
- **Self-contained sections** — each H2 makes sense read alone
|
|
295
|
+
- `sitemap-urls.txt` generated for NotebookLM import
|
|
296
|
+
|
|
297
|
+
## CM DocKit Development Rules
|
|
298
|
+
|
|
299
|
+
If you are an AI agent asked to modify or upgrade this skill (CM DocKit):
|
|
300
|
+
1. **Test Gate Enforcement**: You MUST run the backend test suite located in the `cm-dockit` skill directory by executing `$ npm run test:gate` or `$ vitest`. Do NOT claim "task completed" unless tests pass.
|
|
301
|
+
2. **Boilerplate Integrity**: If modifying `templates/vitepress-premium`, ensure the frontend test suite (`tests/frontend.test.ts`) still works.
|
|
302
|
+
3. **No Direct Copying**: Never hardcode file-copy commands that copy `[project_root]/docs/` content into `docs-site/`. Always rely on `srcDir: '../docs'` in `config.mts`.
|