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,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "cm-dockit",
|
|
3
|
+
"version": "2.1.0",
|
|
4
|
+
"description": "DocKit Master Skill test suite",
|
|
5
|
+
"private": true,
|
|
6
|
+
"type": "module",
|
|
7
|
+
"scripts": {
|
|
8
|
+
"test": "vitest run",
|
|
9
|
+
"test:gate": "vitest run --passWithNoTests"
|
|
10
|
+
},
|
|
11
|
+
"devDependencies": {
|
|
12
|
+
"vitest": "^1.5.0"
|
|
13
|
+
}
|
|
14
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Codebase Analysis Prompt
|
|
2
|
+
|
|
3
|
+
You are DocKit Master, a documentation generator. Analyze the codebase at: {{PROJECT_PATH}}
|
|
4
|
+
|
|
5
|
+
## Task
|
|
6
|
+
|
|
7
|
+
Perform a comprehensive codebase analysis and write the result as a Markdown file.
|
|
8
|
+
|
|
9
|
+
## Instructions
|
|
10
|
+
|
|
11
|
+
1. **Scan the project structure** — list all directories, key files, their sizes
|
|
12
|
+
2. **Identify tech stack** — framework, language, database, deployment target
|
|
13
|
+
3. **Map all routes/endpoints** — method, path, description
|
|
14
|
+
4. **Document database schema** — tables, columns, relationships
|
|
15
|
+
5. **List dependencies** — from package.json/requirements.txt/etc
|
|
16
|
+
6. **Identify test coverage** — test files, framework
|
|
17
|
+
7. **Map key business logic** — core modules and their purpose
|
|
18
|
+
|
|
19
|
+
## Output Format
|
|
20
|
+
|
|
21
|
+
Write a complete Markdown file with:
|
|
22
|
+
- YAML frontmatter (title, description, keywords, robots)
|
|
23
|
+
- Quick Reference box at the top
|
|
24
|
+
- Mermaid diagram for architecture overview
|
|
25
|
+
- Tables for routes, dependencies, database
|
|
26
|
+
- Cross-links to other docs at the bottom
|
|
27
|
+
|
|
28
|
+
## Language
|
|
29
|
+
|
|
30
|
+
Write in: {{LANGUAGE}} (vi = Vietnamese, en = English)
|
|
31
|
+
|
|
32
|
+
## Output File
|
|
33
|
+
|
|
34
|
+
Save to: {{OUTPUT_PATH}}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# API Reference Prompt
|
|
2
|
+
|
|
3
|
+
You are DocKit Master. Create API reference documentation for: {{PROJECT_PATH}}
|
|
4
|
+
|
|
5
|
+
## Task
|
|
6
|
+
|
|
7
|
+
Document all REST API endpoints with examples.
|
|
8
|
+
|
|
9
|
+
## Instructions
|
|
10
|
+
|
|
11
|
+
1. **Auth section** — all authentication methods with examples
|
|
12
|
+
2. **Error codes** — HTTP status table
|
|
13
|
+
3. **Endpoints by group** — tables with method, path, auth, description
|
|
14
|
+
4. **Detailed examples** — in collapsible details tags:
|
|
15
|
+
- Request (method, headers, body)
|
|
16
|
+
- Response (status, body)
|
|
17
|
+
5. **Configuration endpoints** — list all config CRUD
|
|
18
|
+
6. **Report endpoints** — list all analytics/report
|
|
19
|
+
7. **Export endpoints** — list CSV exports
|
|
20
|
+
|
|
21
|
+
## Output
|
|
22
|
+
|
|
23
|
+
Write to: {{OUTPUT_PATH}} in {{LANGUAGE}}.
|
|
24
|
+
Include YAML frontmatter, code blocks for examples.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Architecture Documentation Prompt
|
|
2
|
+
|
|
3
|
+
You are DocKit Master. Create system architecture docs for: {{PROJECT_PATH}}
|
|
4
|
+
|
|
5
|
+
## Task
|
|
6
|
+
|
|
7
|
+
Document the complete system architecture including components, deployment, security, and ADRs.
|
|
8
|
+
|
|
9
|
+
## Instructions
|
|
10
|
+
|
|
11
|
+
1. **Architecture diagram** — Mermaid graph showing all components
|
|
12
|
+
2. **Component table** — name, description, technology, key files
|
|
13
|
+
3. **Sequence diagram** — main request flow
|
|
14
|
+
4. **ADR section** — Architecture Decision Records (with details tags)
|
|
15
|
+
5. **Security section** — auth methods, RBAC roles
|
|
16
|
+
6. **Performance section** — strategies and limits
|
|
17
|
+
|
|
18
|
+
## Output
|
|
19
|
+
|
|
20
|
+
Write to: {{OUTPUT_PATH}} in {{LANGUAGE}}.
|
|
21
|
+
Include YAML frontmatter, dark-mode Mermaid, cross-links.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Data Flow Prompt
|
|
2
|
+
|
|
3
|
+
You are DocKit Master. Create data flow documentation for: {{PROJECT_PATH}}
|
|
4
|
+
|
|
5
|
+
## Task
|
|
6
|
+
|
|
7
|
+
Document end-to-end data flows for all major features.
|
|
8
|
+
|
|
9
|
+
## Instructions
|
|
10
|
+
|
|
11
|
+
1. **Overview diagram** — input → process → output
|
|
12
|
+
2. **Sequence diagram** for each major workflow
|
|
13
|
+
3. **Formulas** — document any calculations with tables
|
|
14
|
+
4. **Integration table** — external services, protocol, direction, data
|
|
15
|
+
5. **Export flows** — CSV generation details
|
|
16
|
+
|
|
17
|
+
## Output
|
|
18
|
+
|
|
19
|
+
Write to: {{OUTPUT_PATH}} in {{LANGUAGE}}.
|
|
20
|
+
Include YAML frontmatter, Mermaid sequence/flow diagrams, cross-links.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Database Schema Prompt
|
|
2
|
+
|
|
3
|
+
You are DocKit Master. Create database schema documentation for: {{PROJECT_PATH}}
|
|
4
|
+
|
|
5
|
+
## Task
|
|
6
|
+
|
|
7
|
+
Document the complete database schema from migrations and SQL files.
|
|
8
|
+
|
|
9
|
+
## Instructions
|
|
10
|
+
|
|
11
|
+
1. **ER diagram** — Mermaid erDiagram with all relationships
|
|
12
|
+
2. **Table definitions** — columns, types, nullable, defaults, descriptions
|
|
13
|
+
3. **Grouped by domain** — organization, config, data, workflow
|
|
14
|
+
4. **Indexes** — table of all indexes and their purpose
|
|
15
|
+
5. **Migration history** — version, description
|
|
16
|
+
6. **Status flows** — for tables with status columns
|
|
17
|
+
|
|
18
|
+
## Output
|
|
19
|
+
|
|
20
|
+
Write to: {{OUTPUT_PATH}} in {{LANGUAGE}}.
|
|
21
|
+
Include YAML frontmatter, cross-links.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Deployment Guide Prompt
|
|
2
|
+
|
|
3
|
+
You are DocKit Master. Create deployment documentation for: {{PROJECT_PATH}}
|
|
4
|
+
|
|
5
|
+
## Task
|
|
6
|
+
|
|
7
|
+
Document how to install, configure, and deploy the system.
|
|
8
|
+
|
|
9
|
+
## Instructions
|
|
10
|
+
|
|
11
|
+
1. **Requirements** — Node.js version, tools, etc.
|
|
12
|
+
2. **Environment variables** — table with name, description, required, example
|
|
13
|
+
3. **Local setup** — step-by-step with code blocks
|
|
14
|
+
4. **Production deployment** — platform-specific instructions
|
|
15
|
+
5. **Demo accounts** — test credentials table
|
|
16
|
+
6. **Health checks** — monitoring endpoints
|
|
17
|
+
7. **Testing** — how to run tests
|
|
18
|
+
|
|
19
|
+
## Output
|
|
20
|
+
|
|
21
|
+
Write to: {{OUTPUT_PATH}} in {{LANGUAGE}}.
|
|
22
|
+
Include YAML frontmatter, Mermaid diagram for deploy flow.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Process Flows Prompt
|
|
2
|
+
|
|
3
|
+
You are DocKit Master. Create process flow diagrams for: {{PROJECT_PATH}}
|
|
4
|
+
|
|
5
|
+
## Task
|
|
6
|
+
|
|
7
|
+
Document all major workflows and state machines in the system.
|
|
8
|
+
|
|
9
|
+
## Instructions
|
|
10
|
+
|
|
11
|
+
1. Identify all status flows (state machines) from database schema
|
|
12
|
+
2. Create Mermaid flowcharts for sequential processes
|
|
13
|
+
3. Create Mermaid stateDiagram for status transitions
|
|
14
|
+
4. Create sequence diagrams for complex multi-actor interactions
|
|
15
|
+
5. Use dark-mode colors (fill: #2d333b, border: #6d5dfc)
|
|
16
|
+
6. Add plain text description below each diagram
|
|
17
|
+
|
|
18
|
+
## Output
|
|
19
|
+
|
|
20
|
+
Write to: {{OUTPUT_PATH}} in {{LANGUAGE}}.
|
|
21
|
+
Include YAML frontmatter, cross-links.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# JTBD Canvases Prompt
|
|
2
|
+
|
|
3
|
+
You are DocKit Master. Create Jobs-to-be-Done analysis for: {{PROJECT_PATH}}
|
|
4
|
+
|
|
5
|
+
## Task
|
|
6
|
+
|
|
7
|
+
Analyze each user persona's jobs using the JTBD framework.
|
|
8
|
+
|
|
9
|
+
## Instructions
|
|
10
|
+
|
|
11
|
+
1. For each persona, identify 3-5 jobs
|
|
12
|
+
2. Format as: "When [situation], I want to [action], so I can [outcome]"
|
|
13
|
+
3. Map each job to specific system features
|
|
14
|
+
4. Include frequency and importance
|
|
15
|
+
5. Use table format
|
|
16
|
+
|
|
17
|
+
## Output
|
|
18
|
+
|
|
19
|
+
Write to: {{OUTPUT_PATH}} in {{LANGUAGE}}.
|
|
20
|
+
Include YAML frontmatter, cross-links to Personas and Flows.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Personas Prompt
|
|
2
|
+
|
|
3
|
+
You are DocKit Master, a documentation generator. Create user personas for the project at: {{PROJECT_PATH}}
|
|
4
|
+
|
|
5
|
+
## Task
|
|
6
|
+
|
|
7
|
+
Generate detailed user personas based on the codebase analysis (RBAC roles, UI flows, API patterns).
|
|
8
|
+
|
|
9
|
+
## Instructions
|
|
10
|
+
|
|
11
|
+
1. **Identify roles** from auth middleware, RBAC config, user tables
|
|
12
|
+
2. **For each persona** create:
|
|
13
|
+
- Name, age, role, frequency of use
|
|
14
|
+
- Goals and pain points
|
|
15
|
+
- Key behaviors (what they do in the system)
|
|
16
|
+
- Most-used features
|
|
17
|
+
3. **Use table format** for structured persona attributes
|
|
18
|
+
4. **Include persona photo description** (for future image generation)
|
|
19
|
+
|
|
20
|
+
## Output
|
|
21
|
+
|
|
22
|
+
Write complete Markdown file to: {{OUTPUT_PATH}}
|
|
23
|
+
Language: {{LANGUAGE}}
|
|
24
|
+
Include YAML frontmatter, Quick Reference box, cross-links.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# SOP Template Prompt
|
|
2
|
+
|
|
3
|
+
You are DocKit Master. Create SOP user guides for: {{PROJECT_PATH}}
|
|
4
|
+
|
|
5
|
+
## Task
|
|
6
|
+
|
|
7
|
+
Generate a complete set of SOP (Standard Operating Procedure) documents.
|
|
8
|
+
|
|
9
|
+
## Instructions
|
|
10
|
+
|
|
11
|
+
1. **SOP Index** — overview of all features with difficulty, role, link
|
|
12
|
+
2. **One SOP per feature/module** including:
|
|
13
|
+
- Quick Reference box (who, where, time, prerequisites)
|
|
14
|
+
- Prerequisites checklist
|
|
15
|
+
- Step-by-step guide with screenshots descriptions
|
|
16
|
+
- Tables for form fields, filter options
|
|
17
|
+
- Expected results section
|
|
18
|
+
- Troubleshooting (in details/collapsible tags)
|
|
19
|
+
- Related features cross-links
|
|
20
|
+
3. **Use admonitions** — :::tip, :::warning for callouts
|
|
21
|
+
4. **Map to API endpoints** at the bottom
|
|
22
|
+
|
|
23
|
+
## Modules to Cover
|
|
24
|
+
|
|
25
|
+
Discover modules from the codebase analysis. Typical modules:
|
|
26
|
+
- Employee management
|
|
27
|
+
- Scoring/rating
|
|
28
|
+
- Violations
|
|
29
|
+
- Recovery/training
|
|
30
|
+
- Bonuses/rewards
|
|
31
|
+
- Benefits calculation
|
|
32
|
+
- Reports/dashboard
|
|
33
|
+
- Configuration/settings
|
|
34
|
+
- Approvals
|
|
35
|
+
- Exports
|
|
36
|
+
|
|
37
|
+
## Output
|
|
38
|
+
|
|
39
|
+
Write index to: {{OUTPUT_PATH}} and individual SOPs to the same directory.
|
|
40
|
+
Language: {{LANGUAGE}}.
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
#!/bin/bash
|
|
2
|
+
# ============================================================
|
|
3
|
+
# Doc-Kit — Documentation Generator CLI
|
|
4
|
+
# Generates optimized prompts for Google Antigravity
|
|
5
|
+
# ============================================================
|
|
6
|
+
|
|
7
|
+
set -e
|
|
8
|
+
|
|
9
|
+
# Colors
|
|
10
|
+
RED='\033[0;31m'
|
|
11
|
+
GREEN='\033[0;32m'
|
|
12
|
+
BLUE='\033[0;34m'
|
|
13
|
+
CYAN='\033[0;36m'
|
|
14
|
+
YELLOW='\033[1;33m'
|
|
15
|
+
BOLD='\033[1m'
|
|
16
|
+
NC='\033[0m' # No Color
|
|
17
|
+
|
|
18
|
+
# Header
|
|
19
|
+
echo ""
|
|
20
|
+
echo -e "${CYAN}╔══════════════════════════════════════════════╗${NC}"
|
|
21
|
+
echo -e "${CYAN}║${NC} ${BOLD}📚 Doc-Kit — Documentation Generator${NC} ${CYAN}║${NC}"
|
|
22
|
+
echo -e "${CYAN}║${NC} ${YELLOW}Powered by Google Antigravity${NC} ${CYAN}║${NC}"
|
|
23
|
+
echo -e "${CYAN}╚══════════════════════════════════════════════╝${NC}"
|
|
24
|
+
echo ""
|
|
25
|
+
|
|
26
|
+
# Step 1: Choose document type
|
|
27
|
+
echo -e "${BOLD}📑 Step 1: Document Type${NC}"
|
|
28
|
+
echo ""
|
|
29
|
+
echo -e " ${GREEN}1)${NC} tech — Technical docs (Architecture, DB, Deployment)"
|
|
30
|
+
echo -e " ${GREEN}2)${NC} sop — SOP User Guides (step-by-step)"
|
|
31
|
+
echo -e " ${GREEN}3)${NC} api — API Reference (endpoints, schemas)"
|
|
32
|
+
echo -e " ${GREEN}4)${NC} all — Full documentation suite"
|
|
33
|
+
echo ""
|
|
34
|
+
read -p "$(echo -e ${BLUE}Select [1-4]:${NC} )" DOC_CHOICE
|
|
35
|
+
|
|
36
|
+
case $DOC_CHOICE in
|
|
37
|
+
1) DOC_TYPE="tech" ;;
|
|
38
|
+
2) DOC_TYPE="sop" ;;
|
|
39
|
+
3) DOC_TYPE="api" ;;
|
|
40
|
+
4) DOC_TYPE="all" ;;
|
|
41
|
+
*) echo -e "${RED}❌ Invalid choice${NC}"; exit 1 ;;
|
|
42
|
+
esac
|
|
43
|
+
|
|
44
|
+
echo ""
|
|
45
|
+
|
|
46
|
+
# Step 2: Choose output format
|
|
47
|
+
echo -e "${BOLD}🎨 Step 2: Output Format${NC}"
|
|
48
|
+
echo ""
|
|
49
|
+
echo -e " ${GREEN}1)${NC} markdown — Plain Markdown (simple, portable)"
|
|
50
|
+
echo -e " ${GREEN}2)${NC} docusaurus — Docusaurus site (beautiful, searchable)"
|
|
51
|
+
echo ""
|
|
52
|
+
read -p "$(echo -e ${BLUE}Select [1-2]:${NC} )" FORMAT_CHOICE
|
|
53
|
+
|
|
54
|
+
case $FORMAT_CHOICE in
|
|
55
|
+
1) FORMAT="markdown" ;;
|
|
56
|
+
2) FORMAT="docusaurus" ;;
|
|
57
|
+
*) echo -e "${RED}❌ Invalid choice${NC}"; exit 1 ;;
|
|
58
|
+
esac
|
|
59
|
+
|
|
60
|
+
echo ""
|
|
61
|
+
|
|
62
|
+
# Step 3: Source code path
|
|
63
|
+
echo -e "${BOLD}📂 Step 3: Source Code Path${NC}"
|
|
64
|
+
echo ""
|
|
65
|
+
read -p "$(echo -e ${BLUE}Path to project root:${NC} )" SOURCE_PATH
|
|
66
|
+
|
|
67
|
+
# Validate path
|
|
68
|
+
if [ ! -d "$SOURCE_PATH" ]; then
|
|
69
|
+
echo -e "${RED}❌ Directory not found: $SOURCE_PATH${NC}"
|
|
70
|
+
exit 1
|
|
71
|
+
fi
|
|
72
|
+
|
|
73
|
+
# Convert to absolute path
|
|
74
|
+
SOURCE_PATH=$(cd "$SOURCE_PATH" && pwd)
|
|
75
|
+
|
|
76
|
+
echo ""
|
|
77
|
+
|
|
78
|
+
# Step 4: Documentation language
|
|
79
|
+
echo -e "${BOLD}🌏 Step 4: Output Language${NC}"
|
|
80
|
+
echo ""
|
|
81
|
+
echo -e " ${GREEN}1)${NC} en — English (default)"
|
|
82
|
+
echo -e " ${GREEN}2)${NC} vi — Tiếng Việt"
|
|
83
|
+
echo ""
|
|
84
|
+
read -p "$(echo -e ${BLUE}Select [1-2] (Enter = English):${NC} )" LANG_CHOICE
|
|
85
|
+
|
|
86
|
+
case $LANG_CHOICE in
|
|
87
|
+
2) DOC_LANG="Vietnamese" ;;
|
|
88
|
+
*) DOC_LANG="English" ;;
|
|
89
|
+
esac
|
|
90
|
+
|
|
91
|
+
echo ""
|
|
92
|
+
echo -e "${CYAN}══════════════════════════════════════════════${NC}"
|
|
93
|
+
echo ""
|
|
94
|
+
|
|
95
|
+
# Generate prompt
|
|
96
|
+
PROMPT="Use the doc-kit skill to generate documentation for the project at: $SOURCE_PATH
|
|
97
|
+
|
|
98
|
+
Configuration:
|
|
99
|
+
- Document type: $DOC_TYPE
|
|
100
|
+
- Output format: $FORMAT
|
|
101
|
+
- Language: $DOC_LANG
|
|
102
|
+
|
|
103
|
+
Please refer to the skill file at skills/doc-kit/SKILL.md and execute the procedure.
|
|
104
|
+
Start from Step 2 (Analyze Codebase) since input parameters are already provided above."
|
|
105
|
+
|
|
106
|
+
echo -e "${BOLD}✅ Prompt successfully generated!${NC}"
|
|
107
|
+
echo ""
|
|
108
|
+
echo -e "${YELLOW}━━━ Copy the prompt below and paste it into Antigravity ━━━${NC}"
|
|
109
|
+
echo ""
|
|
110
|
+
echo -e "${GREEN}$PROMPT${NC}"
|
|
111
|
+
echo ""
|
|
112
|
+
echo -e "${YELLOW}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
|
|
113
|
+
echo ""
|
|
114
|
+
|
|
115
|
+
# Copy to clipboard if pbcopy available (macOS)
|
|
116
|
+
if command -v pbcopy &> /dev/null; then
|
|
117
|
+
echo "$PROMPT" | pbcopy
|
|
118
|
+
echo -e "${GREEN}📋 Copied to clipboard! Paste (Cmd+V) into Antigravity.${NC}"
|
|
119
|
+
fi
|
|
120
|
+
|
|
121
|
+
echo ""
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
#!/bin/bash
|
|
2
|
+
# ============================================================
|
|
3
|
+
# DocKit Master v2 — Progress Dashboard
|
|
4
|
+
# Real-time terminal dashboard for monitoring doc generation
|
|
5
|
+
# ============================================================
|
|
6
|
+
set -euo pipefail
|
|
7
|
+
|
|
8
|
+
# ── Colors ──────────────────────────────────────────────────
|
|
9
|
+
RED='\033[0;31m'; GREEN='\033[0;32m'; BLUE='\033[0;34m'
|
|
10
|
+
CYAN='\033[0;36m'; YELLOW='\033[1;33m'; MAGENTA='\033[0;35m'
|
|
11
|
+
BOLD='\033[1m'; DIM='\033[2m'; NC='\033[0m'
|
|
12
|
+
BG_GREEN='\033[42m'; BG_RED='\033[41m'; BG_YELLOW='\033[43m'
|
|
13
|
+
BG_BLUE='\033[44m'; BG_DIM='\033[100m'
|
|
14
|
+
|
|
15
|
+
# ── Args ────────────────────────────────────────────────────
|
|
16
|
+
PROJECT_PATH="${1:-}"
|
|
17
|
+
REFRESH="${2:-5}" # Refresh interval in seconds
|
|
18
|
+
|
|
19
|
+
if [[ -z "$PROJECT_PATH" ]]; then
|
|
20
|
+
echo "Usage: dockit-dashboard.sh /path/to/project [refresh_seconds]"
|
|
21
|
+
echo ""
|
|
22
|
+
echo " Monitors DocKit Master progress in real-time."
|
|
23
|
+
echo " Default refresh: 5 seconds. Press Ctrl+C to stop."
|
|
24
|
+
exit 1
|
|
25
|
+
fi
|
|
26
|
+
|
|
27
|
+
PROJECT_PATH="$(cd "$PROJECT_PATH" 2>/dev/null && pwd)" || {
|
|
28
|
+
echo "Directory not found: $PROJECT_PATH"
|
|
29
|
+
exit 1
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
PROGRESS_FILE="$PROJECT_PATH/docs/_progress.json"
|
|
33
|
+
|
|
34
|
+
# ── Render Dashboard ────────────────────────────────────────
|
|
35
|
+
render() {
|
|
36
|
+
clear
|
|
37
|
+
|
|
38
|
+
if [[ ! -f "$PROGRESS_FILE" ]]; then
|
|
39
|
+
echo -e "${YELLOW}⏳ Waiting for DocKit Master to start...${NC}"
|
|
40
|
+
echo -e "${DIM}Looking for: $PROGRESS_FILE${NC}"
|
|
41
|
+
return
|
|
42
|
+
fi
|
|
43
|
+
|
|
44
|
+
python3 << 'PYEOF'
|
|
45
|
+
import json, sys, os
|
|
46
|
+
from datetime import datetime, timezone
|
|
47
|
+
|
|
48
|
+
progress_file = os.environ.get("PROGRESS_FILE", "")
|
|
49
|
+
try:
|
|
50
|
+
with open(progress_file, 'r') as f:
|
|
51
|
+
data = json.load(f)
|
|
52
|
+
except Exception as e:
|
|
53
|
+
print(f"\033[1;33m⏳ Waiting for valid progress data...\033[0m")
|
|
54
|
+
sys.exit(0)
|
|
55
|
+
|
|
56
|
+
# Colors
|
|
57
|
+
C = '\033[0;36m'; G = '\033[0;32m'; R = '\033[0;31m'; Y = '\033[1;33m'
|
|
58
|
+
B = '\033[1m'; D = '\033[2m'; N = '\033[0m'; M = '\033[0;35m'
|
|
59
|
+
BG_G = '\033[42m'; BG_R = '\033[41m'; BG_Y = '\033[43m'; BG_B = '\033[44m'; BG_D = '\033[100m'
|
|
60
|
+
|
|
61
|
+
config = data.get('config', {})
|
|
62
|
+
stats = data.get('stats', {})
|
|
63
|
+
tasks = data.get('tasks', [])
|
|
64
|
+
total = stats.get('total', 0)
|
|
65
|
+
done = stats.get('done', 0)
|
|
66
|
+
running = stats.get('running', 0)
|
|
67
|
+
failed = stats.get('failed', 0)
|
|
68
|
+
pending = stats.get('pending', 0)
|
|
69
|
+
|
|
70
|
+
# Header
|
|
71
|
+
print(f"\n{C}╔══════════════════════════════════════════════════════╗{N}")
|
|
72
|
+
print(f"{C}║{N} {B}📊 DocKit Master v2 — Dashboard{N} {C}║{N}")
|
|
73
|
+
print(f"{C}╚══════════════════════════════════════════════════════╝{N}")
|
|
74
|
+
|
|
75
|
+
# Config
|
|
76
|
+
print(f"\n {D}Project:{N} {B}{data.get('project', '?')}{N}")
|
|
77
|
+
print(f" {D}Type:{N} {config.get('type', '?')} {D}Format:{N} {config.get('format', '?')} {D}Lang:{N} {config.get('language', '?')}")
|
|
78
|
+
print(f" {D}Engine:{N} {config.get('engine', '?')} {D}Jobs:{N} {config.get('max_jobs', '?')}")
|
|
79
|
+
|
|
80
|
+
# Progress bar
|
|
81
|
+
pct = int(done / total * 100) if total > 0 else 0
|
|
82
|
+
bar_width = 40
|
|
83
|
+
filled = int(bar_width * done / total) if total > 0 else 0
|
|
84
|
+
bar = '█' * filled + '░' * (bar_width - filled)
|
|
85
|
+
color = G if pct == 100 else (Y if pct > 50 else C)
|
|
86
|
+
print(f"\n {color}{bar}{N} {B}{pct}%{N} ({done}/{total})")
|
|
87
|
+
|
|
88
|
+
# Stats cards
|
|
89
|
+
print(f"\n {BG_G} ✅ Done: {done} {N} {BG_Y} ⏳ Running: {running} {N} {BG_D} ⏸️ Pending: {pending} {N} {BG_R} ❌ Failed: {failed} {N}")
|
|
90
|
+
|
|
91
|
+
# Task table
|
|
92
|
+
print(f"\n {B}{'#':>3} {'Status':^8} {'Task':<32} {'Time':>8}{N}")
|
|
93
|
+
print(f" {'─'*3} {'─'*8} {'─'*32} {'─'*8}")
|
|
94
|
+
|
|
95
|
+
for i, t in enumerate(tasks):
|
|
96
|
+
status = t.get('status', 'pending')
|
|
97
|
+
icon = {'done': f'{G}✅ Done{N}', 'running': f'{Y}⏳ Run {N}', 'pending': f'{D}⏸️ Wait{N}', 'failed': f'{R}❌ Fail{N}'}.get(status, '❓')
|
|
98
|
+
label = t.get('label', t.get('id', '?'))[:32]
|
|
99
|
+
|
|
100
|
+
# Calculate duration
|
|
101
|
+
dur = ''
|
|
102
|
+
if t.get('started_at'):
|
|
103
|
+
try:
|
|
104
|
+
start = datetime.fromisoformat(t['started_at'].replace('Z', '+00:00'))
|
|
105
|
+
if t.get('completed_at'):
|
|
106
|
+
end = datetime.fromisoformat(t['completed_at'].replace('Z', '+00:00'))
|
|
107
|
+
else:
|
|
108
|
+
end = datetime.now(timezone.utc)
|
|
109
|
+
secs = int((end - start).total_seconds())
|
|
110
|
+
if secs < 60:
|
|
111
|
+
dur = f'{secs}s'
|
|
112
|
+
else:
|
|
113
|
+
dur = f'{secs//60}m{secs%60}s'
|
|
114
|
+
except:
|
|
115
|
+
dur = ''
|
|
116
|
+
|
|
117
|
+
print(f" {i+1:>3} {icon} {label:<32} {D}{dur:>8}{N}")
|
|
118
|
+
|
|
119
|
+
# Errors
|
|
120
|
+
failed_tasks = [t for t in tasks if t.get('error')]
|
|
121
|
+
if failed_tasks:
|
|
122
|
+
print(f"\n {R}{B}Errors:{N}")
|
|
123
|
+
for t in failed_tasks:
|
|
124
|
+
print(f" {R}• {t['label']}: {t['error']}{N}")
|
|
125
|
+
|
|
126
|
+
# Footer
|
|
127
|
+
print(f"\n {D}Last updated: {datetime.now().strftime('%H:%M:%S')} Refresh: {os.environ.get('REFRESH', '5')}s Ctrl+C to stop{N}")
|
|
128
|
+
if pct == 100:
|
|
129
|
+
print(f"\n {G}{B}🎉 All tasks completed! Run --audit to review and finalize.{N}")
|
|
130
|
+
print()
|
|
131
|
+
PYEOF
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
# ── Main Loop ───────────────────────────────────────────────
|
|
135
|
+
export PROGRESS_FILE REFRESH
|
|
136
|
+
|
|
137
|
+
trap 'echo -e "\n${DIM}Dashboard closed.${NC}"; exit 0' INT
|
|
138
|
+
|
|
139
|
+
while true; do
|
|
140
|
+
render
|
|
141
|
+
sleep "$REFRESH"
|
|
142
|
+
done
|