@flydocs/cli 0.6.0-alpha.2 → 0.6.0-alpha.21

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.
Files changed (148) hide show
  1. package/dist/cli.js +705 -393
  2. package/package.json +1 -1
  3. package/template/.claude/CLAUDE.md +62 -63
  4. package/template/.claude/agents/implementation-agent.md +1 -1
  5. package/template/.claude/agents/pm-agent.md +1 -1
  6. package/template/.claude/commands/activate.md +1 -1
  7. package/template/.claude/commands/attach.md +1 -1
  8. package/template/.claude/commands/block.md +2 -2
  9. package/template/.claude/commands/capture.md +1 -1
  10. package/template/.claude/commands/close.md +1 -1
  11. package/template/.claude/commands/flydocs-setup.md +387 -74
  12. package/template/.claude/commands/flydocs-upgrade.md +48 -37
  13. package/template/.claude/commands/implement.md +1 -1
  14. package/template/.claude/commands/knowledge.md +61 -0
  15. package/template/.claude/commands/new-project.md +1 -1
  16. package/template/.claude/commands/onboard.md +275 -0
  17. package/template/.claude/commands/project-update.md +1 -1
  18. package/template/.claude/commands/refine.md +1 -1
  19. package/template/.claude/commands/review.md +1 -1
  20. package/template/.claude/commands/start-session.md +1 -1
  21. package/template/.claude/commands/status.md +1 -1
  22. package/template/.claude/commands/validate.md +1 -1
  23. package/template/.claude/commands/wrap-session.md +1 -1
  24. package/template/.claude/hooks/auto-approve.py +132 -0
  25. package/template/.claude/hooks/post-pr-check.py +108 -0
  26. package/template/.claude/hooks/post-transition-check.py +94 -0
  27. package/template/.claude/hooks/prompt-submit.py +513 -0
  28. package/template/.claude/hooks/session-start.py +146 -0
  29. package/template/.claude/hooks/stop-gate.py +109 -0
  30. package/template/.claude/settings.json +41 -4
  31. package/template/.claude/skills/README.md +23 -25
  32. package/template/.claude/skills/flydocs-workflow/SKILL.md +134 -42
  33. package/template/.claude/skills/flydocs-workflow/cursor-rule.mdc +9 -8
  34. package/template/.claude/skills/flydocs-workflow/reference/comment-templates.md +1 -0
  35. package/template/.claude/skills/flydocs-workflow/reference/golden-rules.md +28 -17
  36. package/template/.claude/skills/flydocs-workflow/reference/graph-schema.md +116 -0
  37. package/template/.claude/skills/flydocs-workflow/reference/pr-workflow.md +120 -0
  38. package/template/.claude/skills/flydocs-workflow/reference/priority-estimates.md +37 -15
  39. package/template/.claude/skills/flydocs-workflow/reference/service-descriptor-schema.md +251 -0
  40. package/template/.claude/skills/flydocs-workflow/reference/status-workflow.md +26 -26
  41. package/template/.claude/skills/flydocs-workflow/scripts/_local/__init__.py +0 -0
  42. package/template/.claude/skills/{flydocs-local/scripts/flydocs_api.py → flydocs-workflow/scripts/_local/file_store.py} +137 -47
  43. package/template/.claude/skills/flydocs-workflow/scripts/flydocs_api.py +693 -0
  44. package/template/{.flydocs → .claude/skills/flydocs-workflow}/scripts/generate_manifest.py +4 -4
  45. package/template/.claude/skills/{flydocs-context-graph → flydocs-workflow}/scripts/graph_build.py +132 -1
  46. package/template/.claude/skills/{flydocs-context-graph → flydocs-workflow}/scripts/graph_query.py +18 -5
  47. package/template/.claude/skills/{flydocs-context-graph → flydocs-workflow}/scripts/graph_session.py +1 -10
  48. package/template/.claude/skills/{flydocs-context-graph → flydocs-workflow}/scripts/graph_update.py +4 -4
  49. package/template/.claude/skills/{flydocs-context-graph → flydocs-workflow}/scripts/graph_utils.py +2 -1
  50. package/template/.claude/skills/flydocs-workflow/scripts/issues.py +489 -0
  51. package/template/.claude/skills/flydocs-workflow/scripts/projects.py +144 -0
  52. package/template/.claude/skills/flydocs-workflow/scripts/pull_services.py +128 -0
  53. package/template/.claude/skills/flydocs-workflow/scripts/push_service.py +132 -0
  54. package/template/.claude/skills/flydocs-workflow/scripts/session.py +54 -0
  55. package/template/.claude/skills/flydocs-workflow/scripts/workspace.py +860 -0
  56. package/template/.claude/skills/flydocs-workflow/session.md +63 -25
  57. package/template/.claude/skills/flydocs-workflow/stages/activate.md +18 -7
  58. package/template/.claude/skills/flydocs-workflow/stages/capture.md +10 -5
  59. package/template/.claude/skills/flydocs-workflow/stages/close.md +4 -3
  60. package/template/.claude/skills/flydocs-workflow/stages/implement.md +33 -9
  61. package/template/.claude/skills/flydocs-workflow/stages/refine.md +22 -6
  62. package/template/.claude/skills/flydocs-workflow/stages/review.md +16 -4
  63. package/template/.claude/skills/flydocs-workflow/stages/validate.md +3 -1
  64. package/template/.claude/skills/flydocs-workflow/templates/pr/default.md +33 -0
  65. package/template/.cursor/agents/implementation-agent.md +1 -1
  66. package/template/.cursor/agents/pm-agent.md +2 -2
  67. package/template/.cursor/hooks.json +10 -3
  68. package/template/.env.example +6 -6
  69. package/template/.flydocs/config.json +5 -18
  70. package/template/.flydocs/templates/README.md +13 -14
  71. package/template/.flydocs/templates/quick-capture.md +4 -8
  72. package/template/.flydocs/version +1 -1
  73. package/template/AGENTS.md +39 -32
  74. package/template/CHANGELOG.md +39 -0
  75. package/template/flydocs/README.md +1 -3
  76. package/template/flydocs/context/project.md +6 -3
  77. package/template/flydocs/design-system/README.md +3 -3
  78. package/template/flydocs/knowledge/INDEX.md +38 -53
  79. package/template/flydocs/knowledge/README.md +60 -9
  80. package/template/flydocs/knowledge/templates/decision.md +47 -0
  81. package/template/flydocs/knowledge/templates/feature.md +35 -0
  82. package/template/flydocs/knowledge/templates/note.md +25 -0
  83. package/template/manifest.json +24 -20
  84. package/template/.claude/skills/flydocs-cloud/SKILL.md +0 -111
  85. package/template/.claude/skills/flydocs-cloud/cursor-rule.mdc +0 -50
  86. package/template/.claude/skills/flydocs-cloud/scripts/assign.py +0 -22
  87. package/template/.claude/skills/flydocs-cloud/scripts/assign_cycle.py +0 -28
  88. package/template/.claude/skills/flydocs-cloud/scripts/assign_milestone.py +0 -22
  89. package/template/.claude/skills/flydocs-cloud/scripts/comment.py +0 -29
  90. package/template/.claude/skills/flydocs-cloud/scripts/create_issue.py +0 -63
  91. package/template/.claude/skills/flydocs-cloud/scripts/create_milestone.py +0 -35
  92. package/template/.claude/skills/flydocs-cloud/scripts/create_project.py +0 -33
  93. package/template/.claude/skills/flydocs-cloud/scripts/create_team.py +0 -39
  94. package/template/.claude/skills/flydocs-cloud/scripts/estimate.py +0 -29
  95. package/template/.claude/skills/flydocs-cloud/scripts/flydocs_api.py +0 -210
  96. package/template/.claude/skills/flydocs-cloud/scripts/get_issue.py +0 -24
  97. package/template/.claude/skills/flydocs-cloud/scripts/link.py +0 -28
  98. package/template/.claude/skills/flydocs-cloud/scripts/list_cycles.py +0 -28
  99. package/template/.claude/skills/flydocs-cloud/scripts/list_issues.py +0 -44
  100. package/template/.claude/skills/flydocs-cloud/scripts/list_labels.py +0 -19
  101. package/template/.claude/skills/flydocs-cloud/scripts/list_milestones.py +0 -28
  102. package/template/.claude/skills/flydocs-cloud/scripts/list_projects.py +0 -31
  103. package/template/.claude/skills/flydocs-cloud/scripts/list_teams.py +0 -19
  104. package/template/.claude/skills/flydocs-cloud/scripts/priority.py +0 -29
  105. package/template/.claude/skills/flydocs-cloud/scripts/project_update.py +0 -45
  106. package/template/.claude/skills/flydocs-cloud/scripts/set_labels.py +0 -68
  107. package/template/.claude/skills/flydocs-cloud/scripts/set_team.py +0 -41
  108. package/template/.claude/skills/flydocs-cloud/scripts/transition.py +0 -26
  109. package/template/.claude/skills/flydocs-cloud/scripts/update_description.py +0 -36
  110. package/template/.claude/skills/flydocs-cloud/scripts/update_issue.py +0 -82
  111. package/template/.claude/skills/flydocs-context-graph/SKILL.md +0 -87
  112. package/template/.claude/skills/flydocs-context-graph/schema.md +0 -78
  113. package/template/.claude/skills/flydocs-context-graph/scripts/graph_context.py +0 -338
  114. package/template/.claude/skills/flydocs-context7/SKILL.md +0 -105
  115. package/template/.claude/skills/flydocs-context7/cursor-rule.mdc +0 -49
  116. package/template/.claude/skills/flydocs-context7/scripts/context7.py +0 -293
  117. package/template/.claude/skills/flydocs-estimates/SKILL.md +0 -384
  118. package/template/.claude/skills/flydocs-figma/SKILL.md +0 -377
  119. package/template/.claude/skills/flydocs-figma/references/PROMPTING.md +0 -108
  120. package/template/.claude/skills/flydocs-figma/references/TROUBLESHOOTING.md +0 -112
  121. package/template/.claude/skills/flydocs-local/SKILL.md +0 -103
  122. package/template/.claude/skills/flydocs-local/cursor-rule.mdc +0 -43
  123. package/template/.claude/skills/flydocs-local/scripts/assign.py +0 -20
  124. package/template/.claude/skills/flydocs-local/scripts/comment.py +0 -27
  125. package/template/.claude/skills/flydocs-local/scripts/create_issue.py +0 -44
  126. package/template/.claude/skills/flydocs-local/scripts/estimate.py +0 -37
  127. package/template/.claude/skills/flydocs-local/scripts/get_issue.py +0 -20
  128. package/template/.claude/skills/flydocs-local/scripts/link.py +0 -41
  129. package/template/.claude/skills/flydocs-local/scripts/list_issues.py +0 -34
  130. package/template/.claude/skills/flydocs-local/scripts/priority.py +0 -37
  131. package/template/.claude/skills/flydocs-local/scripts/project_update.py +0 -67
  132. package/template/.claude/skills/flydocs-local/scripts/status_summary.py +0 -16
  133. package/template/.claude/skills/flydocs-local/scripts/transition.py +0 -24
  134. package/template/.claude/skills/flydocs-local/scripts/update_description.py +0 -35
  135. package/template/.claude/skills/flydocs-local/scripts/update_issue.py +0 -84
  136. package/template/.flydocs/hooks/auto-approve.py +0 -71
  137. package/template/.flydocs/hooks/prompt-submit.py +0 -277
  138. package/template/.flydocs/scripts/skill_manager.py +0 -541
  139. package/template/.flydocs/templates/bug.md +0 -166
  140. package/template/.flydocs/templates/chore.md +0 -110
  141. package/template/.flydocs/templates/feature.md +0 -173
  142. package/template/.flydocs/templates/idea.md +0 -122
  143. /package/template/{.flydocs → .claude}/hooks/post-edit.py +0 -0
  144. /package/template/.claude/skills/{flydocs-estimates/references → flydocs-workflow/reference}/provider-costs.md +0 -0
  145. /package/template/.claude/skills/flydocs-workflow/templates/{bug.md → issues/bug.md} +0 -0
  146. /package/template/.claude/skills/flydocs-workflow/templates/{chore.md → issues/chore.md} +0 -0
  147. /package/template/.claude/skills/flydocs-workflow/templates/{feature.md → issues/feature.md} +0 -0
  148. /package/template/.claude/skills/flydocs-workflow/templates/{idea.md → issues/idea.md} +0 -0
@@ -1,31 +1,33 @@
1
1
  # Issue Templates
2
2
 
3
- This folder contains templates for creating and refining Linear issues. Each template includes agent instructions to ensure consistent, high-quality issue structure.
3
+ This folder contains templates for creating and refining issues. Each template includes agent instructions to ensure consistent, high-quality issue structure.
4
4
 
5
5
  ## Template Usage
6
6
 
7
7
  **Agents use these templates when:**
8
+
8
9
  - Creating new issues via `/capture`
9
10
  - Refining issues via `/refine`
10
11
  - Triaging quick captures with `triage` label
11
12
 
12
- **Humans use `quick-capture.md` in Linear** as the default template for fast idea/bug capture.
13
+ **Humans use `quick-capture.md` in their issue tracker** as the default template for fast idea/bug capture.
13
14
 
14
15
  ## Available Templates
15
16
 
16
- | Template | Purpose | When to Use |
17
- |----------|---------|-------------|
18
- | `feature.md` | New functionality | Building something new with user story |
19
- | `bug.md` | Fix defects | Something is broken |
20
- | `chore.md` | Maintenance/cleanup | Refactoring, polish, improvements |
21
- | `idea.md` | Capture concepts | Rough ideas for future exploration |
22
- | `quick-capture.md` | Fast capture | Human entry in Linear (default template) |
17
+ | Template | Purpose | When to Use |
18
+ | ------------------ | ------------------- | ----------------------------------------------- |
19
+ | `feature.md` | New functionality | Building something new with user story |
20
+ | `bug.md` | Fix defects | Something is broken |
21
+ | `chore.md` | Maintenance/cleanup | Refactoring, polish, improvements |
22
+ | `idea.md` | Capture concepts | Rough ideas for future exploration |
23
+ | `quick-capture.md` | Fast capture | Human entry in issue tracker (default template) |
23
24
 
24
25
  ## Agent Instructions
25
26
 
26
- Each template contains `<!-- AGENT: ... -->` comments that guide the AI when filling out sections. These instructions are removed from the final issue in Linear.
27
+ Each template contains `<!-- AGENT: ... -->` comments that guide the AI when filling out sections. These instructions are removed from the final issue in your provider.
27
28
 
28
29
  **Key principles:**
30
+
29
31
  1. Fill all `[bracketed]` sections with specific content
30
32
  2. Don't remove sections - mark as "N/A" if not applicable
31
33
  3. Be specific in acceptance criteria (testable, measurable)
@@ -35,12 +37,9 @@ Each template contains `<!-- AGENT: ... -->` comments that guide the AI when fil
35
37
  ## Template Evolution
36
38
 
37
39
  Update these templates as your workflow evolves:
40
+
38
41
  - Add sections that are consistently needed
39
42
  - Remove sections that are never used
40
43
  - Improve agent instructions based on what works
41
44
 
42
45
  Changes here apply to all future issues.
43
-
44
-
45
-
46
-
@@ -1,8 +1,8 @@
1
- <!--
2
- LINEAR DEFAULT TEMPLATE
1
+ <!--
2
+ PROVIDER DEFAULT TEMPLATE
3
3
  ========================
4
- Copy this to Linear as the default issue template.
5
- This is the ONLY template humans need in Linear.
4
+ Copy this to your issue tracker as the default issue template.
5
+ This is the ONLY template humans need in their issue tracker.
6
6
  Agents apply full templates via /refine.
7
7
  -->
8
8
 
@@ -29,7 +29,3 @@ Agents apply full templates via /refine.
29
29
  ---
30
30
 
31
31
  _Add `triage` label. Agent will classify and structure via `/refine`._
32
-
33
-
34
-
35
-
@@ -1 +1 @@
1
- 0.6.0-alpha.2
1
+ 0.6.0-alpha.21
@@ -1,17 +1,24 @@
1
1
  # FlyDocs Agent Instructions
2
2
 
3
- Prefer reading project documentation over guessing from training data.
4
- When performing workflow, issue management, or process tasks, consult the
5
- relevant documentation files before acting.
3
+ ## Automatic Workflow Behavior
6
4
 
7
- ## Rules
5
+ These behaviors are **always on**. Execute them automatically as part of doing
6
+ the work — do not wait for explicit commands.
8
7
 
9
- 1. **Use scripts for all issue operations.** Create, transition, comment, assign execute scripts, don't describe actions.
10
- 2. **Every status transition gets a comment.** No silent moves.
11
- 3. **Assignment required before In Progress.** Always assign before starting work.
12
- 4. **Checkboxes live in issue description, never comments.** Update the description to track progress.
13
- 5. **Session wrap posts a summary.** Summarize progress at end of session.
14
- 6. **No secrets in commits.** Never commit `.env`, credentials, or API keys.
8
+ - **Starting work on an issue** transition to In Progress (assign first if needed)
9
+ - **Completing implementation** transition to Review with summary
10
+ - **Closing** verify acceptance criteria, transition to Complete
11
+ - **Every transition gets a comment** no silent moves, no exceptions
12
+ - **Checkboxes in description, never comments** update AC as you go
13
+ - **Session wrap posts a summary** via `session.py project-update`
14
+
15
+ Use dispatcher scripts for all issue operations — execute, don't describe.
16
+
17
+ ## Efficiency
18
+
19
+ Do NOT read skill files or workflow documentation before writing code.
20
+ The rules above are already in your context. For general coding, research,
21
+ and building features — just do the work.
15
22
 
16
23
  ## Workflow
17
24
 
@@ -37,16 +44,20 @@ Detailed procedures: `.claude/skills/flydocs-workflow/`
37
44
 
38
45
  Scripts handle all issue management. The active backend (local files or cloud provider) determines the implementation.
39
46
 
40
- **Available operations:** create issue, transition status, add comment, list issues, get issue details, assign, update description, status summary.
47
+ **Available operations:** create issue, transition status, add comment, list issues, get issue details, assign, update description, estimate, priority, link, block, project update, status summary.
41
48
 
42
- Script location: `.claude/skills/flydocs-local/scripts/` or `.claude/skills/flydocs-cloud/scripts/`
49
+ Scripts use grouped dispatchers in `.claude/skills/flydocs-workflow/scripts/`:
43
50
 
44
- ## Premium Skills
51
+ | Dispatcher | Operations |
52
+ | ---------------- | ------------------------------------------------------------ |
53
+ | `issues.py` | create, get, list, transition, assign, update, comment, etc. |
54
+ | `projects.py` | list-projects, create-project, milestones, cycles |
55
+ | `workspace.py` | validate, labels, statuses, teams, config, identity |
56
+ | `session.py` | project-update, status-summary |
57
+ | `graph_*.py` | build, query, update, session recording |
58
+ | `push/pull_*.py` | Service descriptor sync (cloud tier) |
45
59
 
46
- | Skill | Documentation |
47
- | ----------------- | ----------------------------------------------------------------------- |
48
- | Figma Integration | `.claude/skills/flydocs-figma/` — design extraction, token mapping |
49
- | Cost Estimation | `.claude/skills/flydocs-estimates/` — AI token/labor estimates (opt-in) |
60
+ The unified client auto-detects tier (cloud vs local) — scripts never check tier directly.
50
61
 
51
62
  ## Writing Style
52
63
 
@@ -80,26 +91,22 @@ Follow these rules in every response for consistent, scannable output.
80
91
 
81
92
  ## Project Context
82
93
 
83
- | File | Purpose |
84
- | ---------------------------- | ------------------------------------------------------- |
85
- | `flydocs/context/project.md` | Product scope, tech stack, active priorities |
86
- | `.flydocs/config.json` | Configuration — tier, provider, labels, active projects |
94
+ | File | Purpose |
95
+ | ------------------------------ | ------------------------------------------------- |
96
+ | `flydocs/context/project.md` | Product scope, tech stack, active priorities |
97
+ | `flydocs/context/service.json` | Service descriptor, topology, cross-repo context |
98
+ | `.flydocs/config.json` | Tier, provider, labels, active projects, topology |
87
99
 
88
100
  <!-- flydocs:skills-manifest:start -->
89
101
 
90
102
  ## Skills Index
91
103
 
92
- IMPORTANT: Prefer skill-led reasoning over pre-training reasoning.
93
- Consult the relevant skill BEFORE writing code or making workflow decisions.
94
-
95
- | Skill | Triggers | Entry |
96
- | ----------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
97
- | flydocs-cloud | create issue, transition, comment, list issues, assign, update description, update issue, project update, Linear, cloud | .claude/skills/flydocs-cloud/SKILL.md |
98
- | flydocs-context7 | context7, library docs, documentation lookup, framework docs, package docs, API reference | .claude/skills/flydocs-context7/SKILL.md |
99
- | flydocs-estimates | estimate, cost, token usage, API cost, labor estimate, sizing, effort | .claude/skills/flydocs-estimates/SKILL.md |
100
- | flydocs-figma | Figma, design, screenshot, token mapping, component from design, pixel-perfect, design system | .claude/skills/flydocs-figma/SKILL.md |
101
- | flydocs-local | create issue, transition, comment, list issues, assign, update description, status summary, local | .claude/skills/flydocs-local/SKILL.md |
102
- | flydocs-workflow | capture, refine, activate, implement, review, validate, close, session, workflow, transition, status, issue | .claude/skills/flydocs-workflow/SKILL.md |
104
+ Consult the workflow skill for **issue operations and status transitions only**.
105
+ For general coding tasks, skip this just write code.
106
+
107
+ | Skill | Triggers | Entry |
108
+ | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
109
+ | flydocs-workflow | create issue, capture issue, log a bug, add to backlog, transition, move to, mark as, set status, assign issue, close issue, start session, wrap session, project update, status update, add comment, set priority, set estimate | .claude/skills/flydocs-workflow/SKILL.md |
103
110
 
104
111
  <!-- flydocs:skills-manifest:end -->
105
112
 
@@ -7,6 +7,45 @@ Versioning: [Semantic Versioning](https://semver.org/).
7
7
 
8
8
  ---
9
9
 
10
+ ## [0.6.0-alpha.4] — 2026-03-13
11
+
12
+ ### Added
13
+
14
+ - **Status mapping** — new `list_statuses.py` and `set_status_mapping.py`
15
+ scripts. Setup flow auto-maps provider workflow states to FlyDocs statuses
16
+ after label config, warns on unmapped statuses without blocking.
17
+
18
+ ---
19
+
20
+ ## [0.6.0-alpha.3] — 2026-03-13
21
+
22
+ ### Added
23
+
24
+ - **Provider selection** — new `list_providers.py` and `set_provider.py`
25
+ scripts for multi-provider support (Linear + Jira). Setup flow detects
26
+ connected providers before team selection.
27
+ - **Inline API key prompt** — `flydocs install` now prompts for FlyDocs API
28
+ key when cloud tier is selected. No separate `flydocs connect` step needed.
29
+ - **Existing config detection** — install detects pre-existing `.claude/CLAUDE.md`,
30
+ `settings.json`, `hooks.json`, and `AGENTS.md`. Prompts user to overwrite
31
+ (with backup) or preserve.
32
+ - **`--project` flag** — `create_issue.py` accepts `--project <id>` to scope
33
+ issues to a specific project. Fixes milestone/project mismatch during setup.
34
+ - **Team creation** — `create_team.py` with `--parent` flag for sub-teams.
35
+
36
+ ### Changed
37
+
38
+ - **Setup flow restructured** — Phase 2 now starts with provider detection,
39
+ then team selection, project, labels. Milestones and issues pass `--project`.
40
+ - **Community skill output** — install shows one line per skill instead of
41
+ 4-5 verbose lines. "No triggers" warning suppressed for community skills.
42
+ - **`/flydocs-upgrade` streamlined** — Phase 1 inlines API key handling
43
+ instead of requiring a separate terminal step.
44
+ - **API key helpers extracted** — shared `api-key.ts` module used by both
45
+ `install` and `connect` commands.
46
+
47
+ ---
48
+
10
49
  ## [0.6.0-alpha.1] — 2026-03-12
11
50
 
12
51
  ### Added
@@ -30,8 +30,6 @@ FlyDocs will **never overwrite** these files during updates - they're yours to m
30
30
  ├── config.json # Tier, provider settings, workspace config
31
31
  ├── version # For upgrade detection
32
32
  ├── rules/ # Workflow rules
33
- ├── scripts/ # Automation scripts
34
- ├── hooks/ # Workflow hooks
35
33
  └── templates/ # Issue templates (source)
36
34
 
37
35
  flydocs/ # PROJECT CONTENT (evolves with project)
@@ -153,7 +151,7 @@ See `.flydocs/config.json` for:
153
151
  - FlyDocs version
154
152
  - `tier` - "local" (free) or "cloud" (connected to provider)
155
153
  - `paths.content` - This folder name (default: "flydocs")
156
- - `provider.type` - Issue tracker provider (null for local, "linear" for cloud)
154
+ - `provider.type` - Issue tracker provider (null for local, e.g. "linear", "jira" for cloud)
157
155
  - `workspace.activeProjects` - Array of active project IDs (cloud tier)
158
156
  - `workspace.product` - Product identity (name, labelIds, icon, color)
159
157
  - `statusMapping` - Workflow state names
@@ -3,11 +3,13 @@
3
3
  ## What This Is
4
4
 
5
5
  <!-- Fill during setup: 2-3 sentences describing the project -->
6
+
6
7
  [Project name] — [what it does and who it's for].
7
8
 
8
9
  ## Stack
9
10
 
10
11
  <!-- Fill during setup: auto-detected or manual -->
12
+
11
13
  - **Framework**: [e.g., Next.js 14 / React 18]
12
14
  - **Language**: [e.g., TypeScript 5.x]
13
15
  - **Styling**: [e.g., Tailwind CSS]
@@ -20,8 +22,8 @@
20
22
  Code standards are defined by installed community skills. Skills are installed
21
23
  based on detected stack during setup or manually via `npx flydocs skills add`.
22
24
 
23
- Read the relevant skill before writing code in that domain. List installed skills
24
- with `npx flydocs skills list`.
25
+ Installed community skills provide domain-specific patterns. List them with
26
+ `npx flydocs skills list`.
25
27
 
26
28
  ### Project-Specific Standards
27
29
 
@@ -36,6 +38,7 @@ Project notes: `flydocs/knowledge/notes/`
36
38
  ## Active Priorities
37
39
 
38
40
  <!-- Updated by session-wrap or manually -->
41
+
39
42
  1. [Current priority 1]
40
43
  2. [Current priority 2]
41
44
  3. [Current priority 3]
@@ -48,4 +51,4 @@ Project notes: `flydocs/knowledge/notes/`
48
51
 
49
52
  ---
50
53
 
51
- *Last Updated: YYYY-MM-DD*
54
+ _Last Updated: YYYY-MM-DD_
@@ -6,7 +6,7 @@
6
6
 
7
7
  ## Purpose
8
8
 
9
- When using the `flydocs-figma` skill to extract designs, the AI needs to know:
9
+ When using the workflow skill's Figma capabilities to extract designs, the AI needs to know:
10
10
 
11
11
  1. **How Figma tokens map to code** (colors, spacing, typography)
12
12
  2. **What component patterns exist** (and how to match them)
@@ -83,9 +83,9 @@ flydocs/design-system/
83
83
 
84
84
  ---
85
85
 
86
- ## Integration with flydocs-figma Skill
86
+ ## Integration with Figma Workflow
87
87
 
88
- The `flydocs-figma` skill references this directory:
88
+ The `flydocs-workflow` skill's Figma capabilities reference this directory:
89
89
 
90
90
  1. **Before extraction** - Loads token-mapping.md for translation rules
91
91
  2. **During extraction** - Matches Figma elements to documented patterns
@@ -4,97 +4,82 @@
4
4
  AGENT INSTRUCTIONS:
5
5
  - Scan this file FIRST when looking for existing knowledge
6
6
  - Use descriptions to assess relevance before loading full docs
7
- - Update this index when adding new knowledge docs
7
+ - Update this index when adding or modifying knowledge docs
8
+ - Always use real dates, never leave as YYYY-MM-DD
8
9
  -->
9
10
 
10
11
  ## Quick Reference
11
12
 
12
- | Category | Count | Last Updated |
13
- |----------|-------|--------------|
14
- | Decisions | 0 | - |
15
- | Features | 0 | - |
16
- | Notes | 0 | - |
17
- | Product | 2 | YYYY-MM-DD |
13
+ | Category | Count | Last Updated |
14
+ | --------- | ----- | ------------ |
15
+ | Decisions | 0 | - |
16
+ | Features | 0 | - |
17
+ | Notes | 0 | - |
18
+ | Product | 2 | - |
18
19
 
19
20
  ---
20
21
 
21
- ## 📋 Decisions (ADRs)
22
+ ## Decisions (ADRs)
22
23
 
23
- Architecture Decision Records - why we made key technical choices.
24
+ Architecture Decision Records why we made key technical choices.
24
25
 
25
- | ID | Title | Status | Date |
26
- |----|-------|--------|------|
27
- | - | No decisions recorded yet | - | - |
26
+ | ID | Title | Status | Date |
27
+ | --- | ------------------------- | ------ | ---- |
28
+ | - | No decisions recorded yet | - | - |
28
29
 
29
30
  <!-- Example:
30
- | 001 | Use Convex for Backend | Accepted | 2024-01-15 |
31
- Explains why we chose Convex over traditional REST API
31
+ | 001 | Use Convex for Backend | Accepted | 2026-01-15 |
32
+ -> Explains why we chose Convex over traditional REST API
32
33
  -->
33
34
 
34
35
  ---
35
36
 
36
- ## 🔧 Features
37
+ ## Features
37
38
 
38
39
  Documentation for complex features that need more than a spec.
39
40
 
40
- | Feature | Description | Last Updated |
41
- |---------|-------------|--------------|
42
- | - | No feature docs yet | - |
41
+ | Feature | Description | Last Updated |
42
+ | ------- | ------------------- | ------------ |
43
+ | - | No feature docs yet | - |
43
44
 
44
45
  <!-- Example:
45
- | auth-system | Complete auth flow documentation | 2024-02-01 |
46
- OAuth setup, session handling, role-based access
46
+ | auth-system | Complete auth flow documentation | 2026-02-01 |
47
+ -> OAuth setup, session handling, role-based access
47
48
  -->
48
49
 
49
50
  ---
50
51
 
51
- ## 📝 Notes
52
+ ## Notes
52
53
 
53
54
  Technical discoveries, gotchas, learnings.
54
55
 
55
- | Topic | Description | Added |
56
- |-------|-------------|-------|
57
- | - | No notes yet | - |
56
+ | Topic | Description | Added |
57
+ | ----- | ------------ | ----- |
58
+ | - | No notes yet | - |
58
59
 
59
60
  <!-- Example:
60
- | api-rate-limits | Third-party API quirks and workarounds | 2024-01-20 |
61
- Stripe webhook retries, Figma API limits, etc.
61
+ | api-rate-limits | Third-party API quirks and workarounds | 2026-01-20 |
62
+ -> Stripe webhook retries, Figma API limits, etc.
62
63
  -->
63
64
 
64
65
  ---
65
66
 
66
- ## 👥 Product
67
+ ## Product
67
68
 
68
69
  User research and product documentation.
69
70
 
70
- | Document | Description | Last Updated |
71
- |----------|-------------|--------------|
72
- | personas.md | Target user profiles | YYYY-MM-DD |
73
- | user-flows.md | Key user journeys | YYYY-MM-DD |
71
+ | Document | Description | Last Updated |
72
+ | ------------- | -------------------- | ------------ |
73
+ | personas.md | Target user profiles | - |
74
+ | user-flows.md | Key user journeys | - |
74
75
 
75
76
  ---
76
77
 
77
78
  ## How to Add Knowledge
78
79
 
79
- ### New Decision (ADR)
80
- ```bash
81
- # Create: flydocs/knowledge/decisions/NNN-title.md
82
- # Update: This index with new entry
83
- ```
84
-
85
- ### New Feature Doc
86
- ```bash
87
- # Create: flydocs/knowledge/features/feature-name.md
88
- # Update: This index with new entry
89
- ```
90
-
91
- ### New Note
92
- ```bash
93
- # Create: flydocs/knowledge/notes/topic-name.md
94
- # Update: This index with new entry
95
- ```
96
-
97
- ---
98
-
99
- *Last Updated: YYYY-MM-DD*
100
-
80
+ 1. Choose the category: decision, feature, note, or product
81
+ 2. Copy the template from `templates/<category>.md`
82
+ 3. Fill in the frontmatter (title, created date, related issues)
83
+ 4. Write the content following the template structure
84
+ 5. Add an entry to this index with a concise description
85
+ 6. Use the `/knowledge` command for a guided flow
@@ -6,42 +6,78 @@ This directory contains project knowledge that accumulates over time.
6
6
 
7
7
  ```
8
8
  knowledge/
9
- ├── INDEX.md # Start here - inventory of all knowledge
10
- ├── decisions/ # Architecture Decision Records (ADRs)
11
- ├── features/ # Complex feature documentation
12
- ├── notes/ # Technical discoveries and learnings
13
- └── product/ # User research and product docs
9
+ ├── INDEX.md # Start here inventory of all knowledge
10
+ ├── templates/ # Structural templates for each category
11
+ ├── decisions/ # Architecture Decision Records (ADRs)
12
+ ├── features/ # Complex feature documentation
13
+ ├── notes/ # Technical discoveries and learnings
14
+ └── product/ # User research and product docs
14
15
  ```
15
16
 
16
- ## When to Add Knowledge
17
+ ## Templates
18
+
19
+ Use templates from `templates/` when creating new knowledge docs. Each template includes
20
+ a frontmatter block with required metadata fields.
21
+
22
+ ### Required Frontmatter
23
+
24
+ All knowledge docs must include YAML frontmatter:
25
+
26
+ ```yaml
27
+ ---
28
+ title: "Descriptive title"
29
+ created: 2026-03-17
30
+ lastUpdated: 2026-03-17
31
+ relatedIssues: [FLY-123, FLY-456]
32
+ ---
33
+ ```
34
+
35
+ Additional fields vary by category — see the template for each type.
36
+
37
+ **Always update `lastUpdated`** when modifying an existing doc.
38
+
39
+ ## When to Create Knowledge
17
40
 
18
41
  ### Decisions (`decisions/`)
42
+
19
43
  Add an ADR when you make a significant technical choice:
44
+
20
45
  - Choosing a framework or library
21
46
  - Designing a system architecture
22
47
  - Establishing a pattern that others should follow
48
+ - Rejecting an approach (document why, so others don't repeat the investigation)
23
49
 
24
50
  **Format**: `NNN-title.md` (e.g., `001-use-convex.md`)
51
+ **Template**: `templates/decision.md`
25
52
 
26
53
  ### Features (`features/`)
54
+
27
55
  Add feature documentation when:
56
+
28
57
  - A feature is too complex for just a spec
29
58
  - Multiple specs relate to one system
30
59
  - Future developers will need deep context
31
60
 
32
61
  **Format**: `feature-name.md` (e.g., `auth-system.md`)
62
+ **Template**: `templates/feature.md`
33
63
 
34
64
  ### Notes (`notes/`)
65
+
35
66
  Add notes when you discover:
67
+
36
68
  - API quirks or gotchas
37
69
  - Performance optimizations
38
70
  - Debugging techniques
39
71
  - Third-party service behaviors
72
+ - Workarounds that aren't obvious from code
40
73
 
41
74
  **Format**: `topic-name.md` (e.g., `stripe-webhooks.md`)
75
+ **Template**: `templates/note.md`
42
76
 
43
77
  ### Product (`product/`)
78
+
44
79
  Add product docs for:
80
+
45
81
  - User personas
46
82
  - User flows and journeys
47
83
  - Research findings
@@ -49,14 +85,29 @@ Add product docs for:
49
85
 
50
86
  **Format**: `document-name.md` (e.g., `personas.md`)
51
87
 
88
+ ## When to Prompt for Knowledge Capture
89
+
90
+ Proactively suggest creating a knowledge doc when:
91
+
92
+ - An architectural decision was made during implementation
93
+ - A non-obvious workaround or debugging technique was discovered
94
+ - A third-party API or integration behavior was learned through trial and error
95
+ - A pattern was established that future work should follow
96
+ - A significant feature was completed that spans multiple issues
97
+
98
+ The `/knowledge` command provides a guided flow for creating docs.
99
+
52
100
  ## Always Update INDEX.md
53
101
 
54
- When adding any knowledge document, update `INDEX.md` so agents can discover it.
102
+ When adding or modifying any knowledge document:
103
+
104
+ 1. Add or update the entry in `INDEX.md`
105
+ 2. Set the date to the current date (never leave as `YYYY-MM-DD`)
106
+ 3. Write a concise description that helps agents assess relevance without loading the full doc
55
107
 
56
108
  ## Relationship to Specs
57
109
 
58
- - **Specs** (in Linear) = What we're building now
110
+ - **Specs** (in issue tracker) = What we're building now
59
111
  - **Knowledge** (here) = What we've learned that persists
60
112
 
61
113
  Specs reference knowledge. Knowledge grows from implementing specs.
62
-
@@ -0,0 +1,47 @@
1
+ ---
2
+ id: NNN
3
+ title: "[Decision title]"
4
+ status: proposed | accepted | deprecated | superseded
5
+ created: YYYY-MM-DD
6
+ lastUpdated: YYYY-MM-DD
7
+ relatedIssues: []
8
+ supersededBy: null
9
+ ---
10
+
11
+ # NNN — [Decision Title]
12
+
13
+ ## Status
14
+
15
+ [Proposed | Accepted | Deprecated | Superseded by NNN]
16
+
17
+ ## Context
18
+
19
+ [What is the problem or situation that requires a decision? Include relevant constraints, requirements, and prior art.]
20
+
21
+ ## Decision
22
+
23
+ [What was decided. Be specific — name the technology, pattern, or approach chosen.]
24
+
25
+ ## Alternatives Considered
26
+
27
+ | Option | Pros | Cons |
28
+ | --------------- | ------------ | -------------------- |
29
+ | [Chosen option] | [Advantages] | [Tradeoffs accepted] |
30
+ | [Alternative 1] | [Advantages] | [Why not chosen] |
31
+ | [Alternative 2] | [Advantages] | [Why not chosen] |
32
+
33
+ ## Consequences
34
+
35
+ **Positive:**
36
+
37
+ - [Benefit 1]
38
+ - [Benefit 2]
39
+
40
+ **Negative / Tradeoffs:**
41
+
42
+ - [Tradeoff 1]
43
+ - [Tradeoff 2]
44
+
45
+ **Follow-up actions:**
46
+
47
+ - [Action needed as a result of this decision]
@@ -0,0 +1,35 @@
1
+ ---
2
+ title: "[Feature name]"
3
+ status: draft | current | deprecated
4
+ created: YYYY-MM-DD
5
+ lastUpdated: YYYY-MM-DD
6
+ relatedIssues: []
7
+ ---
8
+
9
+ # [Feature Name]
10
+
11
+ ## Overview
12
+
13
+ [What this feature does and why it exists. 2-3 sentences.]
14
+
15
+ ## Architecture
16
+
17
+ [How the feature is structured — key components, data flow, integration points.]
18
+
19
+ ## Key Files
20
+
21
+ | File | Purpose |
22
+ | -------------- | ------------------------------ |
23
+ | `path/to/file` | [What it does in this feature] |
24
+
25
+ ## Behaviors
26
+
27
+ [Important behaviors, edge cases, or business rules that aren't obvious from code alone.]
28
+
29
+ ## Configuration
30
+
31
+ [Any config, env vars, or feature flags that affect this feature.]
32
+
33
+ ## Related
34
+
35
+ - [Links to related issues, decisions, or other knowledge docs]