ima-claude 2.9.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/LICENSE +21 -0
- package/README.md +463 -0
- package/dist/cli.js +1064 -0
- package/package.json +49 -0
- package/platforms/claude/adapter.ts +115 -0
- package/platforms/junie/adapter.ts +254 -0
- package/platforms/junie/agents-template.md +113 -0
- package/platforms/junie/hook-translations.md +84 -0
- package/platforms/shared/detector.ts +27 -0
- package/platforms/shared/installer.ts +202 -0
- package/platforms/shared/types.ts +78 -0
- package/plugins/ima-claude/.claude-plugin/plugin.json +25 -0
- package/plugins/ima-claude/agents/explorer.md +30 -0
- package/plugins/ima-claude/agents/implementer.md +30 -0
- package/plugins/ima-claude/agents/memory.md +42 -0
- package/plugins/ima-claude/agents/reviewer.md +53 -0
- package/plugins/ima-claude/agents/tester.md +33 -0
- package/plugins/ima-claude/agents/wp-developer.md +46 -0
- package/plugins/ima-claude/hooks/README.md +145 -0
- package/plugins/ima-claude/hooks/atlassian_prereqs.py +112 -0
- package/plugins/ima-claude/hooks/block_sed_edits.py +59 -0
- package/plugins/ima-claude/hooks/bootstrap.sh +90 -0
- package/plugins/ima-claude/hooks/bootstrap_utility_check.py +94 -0
- package/plugins/ima-claude/hooks/composer_autoload_check.py +70 -0
- package/plugins/ima-claude/hooks/docs_organization.py +104 -0
- package/plugins/ima-claude/hooks/enforce_rg_over_grep.py +56 -0
- package/plugins/ima-claude/hooks/fp_utility_check.py +90 -0
- package/plugins/ima-claude/hooks/hook_logger.py +69 -0
- package/plugins/ima-claude/hooks/hooks.json +239 -0
- package/plugins/ima-claude/hooks/jira_issue_fetch.py +79 -0
- package/plugins/ima-claude/hooks/jquery_in_wordpress.py +92 -0
- package/plugins/ima-claude/hooks/memory_bootstrap.py +79 -0
- package/plugins/ima-claude/hooks/memory_store_reminder.py +75 -0
- package/plugins/ima-claude/hooks/prompt_coach.py +125 -0
- package/plugins/ima-claude/hooks/prompt_coach_digest.md +48 -0
- package/plugins/ima-claude/hooks/prompt_coach_system.md +30 -0
- package/plugins/ima-claude/hooks/sequential_thinking_check.py +81 -0
- package/plugins/ima-claude/hooks/serena_over_grep.py +96 -0
- package/plugins/ima-claude/hooks/serena_over_read.py +66 -0
- package/plugins/ima-claude/hooks/serena_project_check.py +133 -0
- package/plugins/ima-claude/hooks/sql_injection_check.py +73 -0
- package/plugins/ima-claude/hooks/task_master_after_plan.py +31 -0
- package/plugins/ima-claude/hooks/task_master_before_impl.py +93 -0
- package/plugins/ima-claude/hooks/tavily_extract_advanced.py +48 -0
- package/plugins/ima-claude/hooks/vestige_before_external.py +86 -0
- package/plugins/ima-claude/hooks/webfetch_to_tavily.py +42 -0
- package/plugins/ima-claude/hooks/websearch_to_tavily.py +41 -0
- package/plugins/ima-claude/hooks/wp_security_check.py +150 -0
- package/plugins/ima-claude/personalities/README.md +45 -0
- package/plugins/ima-claude/personalities/enable-40k.md +69 -0
- package/plugins/ima-claude/personalities/enable-templars.md +69 -0
- package/plugins/ima-claude/skills/.research-summary.md +340 -0
- package/plugins/ima-claude/skills/architect/SKILL.md +304 -0
- package/plugins/ima-claude/skills/compound-bridge/SKILL.md +200 -0
- package/plugins/ima-claude/skills/discourse/SKILL.md +440 -0
- package/plugins/ima-claude/skills/discourse-admin/SKILL.md +192 -0
- package/plugins/ima-claude/skills/discourse-admin/references/api-endpoints.md +441 -0
- package/plugins/ima-claude/skills/discourse-admin/references/gotchas.md +107 -0
- package/plugins/ima-claude/skills/discourse-admin/references/staging-defaults.md +98 -0
- package/plugins/ima-claude/skills/discourse-admin/scripts/discourse-admin.py +319 -0
- package/plugins/ima-claude/skills/docs-organize/SKILL.md +254 -0
- package/plugins/ima-claude/skills/docs-organize/templates/active-README.md +50 -0
- package/plugins/ima-claude/skills/docs-organize/templates/archive-README.md +57 -0
- package/plugins/ima-claude/skills/docs-organize/templates/docs-README.md +43 -0
- package/plugins/ima-claude/skills/docs-organize/templates/phase-archive-README.md +83 -0
- package/plugins/ima-claude/skills/docs-organize/templates/section-README.md +48 -0
- package/plugins/ima-claude/skills/docs-organize/templates/transient-README.md +79 -0
- package/plugins/ima-claude/skills/docs-organize/templates/transient-gitignore +9 -0
- package/plugins/ima-claude/skills/ember-discourse/SKILL.md +496 -0
- package/plugins/ima-claude/skills/functional-programmer/SKILL.md +258 -0
- package/plugins/ima-claude/skills/ima-bootstrap/SKILL.md +278 -0
- package/plugins/ima-claude/skills/ima-bootstrap/references/bootstrap-patterns.md +356 -0
- package/plugins/ima-claude/skills/ima-bootstrap/references/ima-brand.md +273 -0
- package/plugins/ima-claude/skills/ima-bootstrap/references/theme-integration.md +212 -0
- package/plugins/ima-claude/skills/ima-brand/SKILL.md +108 -0
- package/plugins/ima-claude/skills/ima-brand/references/brand-identity.md +140 -0
- package/plugins/ima-claude/skills/ima-brand/references/digital-standards.md +180 -0
- package/plugins/ima-claude/skills/ima-brand/references/visual-system.md +173 -0
- package/plugins/ima-claude/skills/ima-forms-expert/SKILL.md +175 -0
- package/plugins/ima-claude/skills/ima-forms-expert/references/container-components.md +154 -0
- package/plugins/ima-claude/skills/ima-forms-expert/references/examples.md +328 -0
- package/plugins/ima-claude/skills/ima-forms-expert/references/field-components.md +298 -0
- package/plugins/ima-claude/skills/ima-forms-expert/references/form-factory.md +193 -0
- package/plugins/ima-claude/skills/ima-forms-expert/references/quick-reference.md +153 -0
- package/plugins/ima-claude/skills/ima-forms-expert/references/validation-engine.md +336 -0
- package/plugins/ima-claude/skills/jira-checkpoint/SKILL.md +178 -0
- package/plugins/ima-claude/skills/jquery/SKILL.md +413 -0
- package/plugins/ima-claude/skills/js-fp/SKILL.md +463 -0
- package/plugins/ima-claude/skills/js-fp/core-principles.md +487 -0
- package/plugins/ima-claude/skills/js-fp/examples/pure-functions.js +260 -0
- package/plugins/ima-claude/skills/js-fp/examples/tests/pure-functions.test.js +262 -0
- package/plugins/ima-claude/skills/js-fp/references/anti-patterns.md +120 -0
- package/plugins/ima-claude/skills/js-fp/references/performance-patterns.md +116 -0
- package/plugins/ima-claude/skills/js-fp/references/testing-patterns.md +134 -0
- package/plugins/ima-claude/skills/js-fp-api/SKILL.md +280 -0
- package/plugins/ima-claude/skills/js-fp-api/examples/crud-endpoint.js +258 -0
- package/plugins/ima-claude/skills/js-fp-api/references/middleware-patterns.md +134 -0
- package/plugins/ima-claude/skills/js-fp-api/references/security-sql.md +110 -0
- package/plugins/ima-claude/skills/js-fp-api/references/validation-patterns.md +165 -0
- package/plugins/ima-claude/skills/js-fp-react/SKILL.md +447 -0
- package/plugins/ima-claude/skills/js-fp-react/examples/ProductCard.tsx +65 -0
- package/plugins/ima-claude/skills/js-fp-react/references/hooks-advanced.md +136 -0
- package/plugins/ima-claude/skills/js-fp-react/references/performance-patterns.md +175 -0
- package/plugins/ima-claude/skills/js-fp-vue/SKILL.md +322 -0
- package/plugins/ima-claude/skills/js-fp-vue/references/complete-examples.md +397 -0
- package/plugins/ima-claude/skills/js-fp-vue/references/composables-advanced.md +282 -0
- package/plugins/ima-claude/skills/js-fp-vue/references/reactivity-patterns.md +348 -0
- package/plugins/ima-claude/skills/js-fp-vue/references/testing.md +314 -0
- package/plugins/ima-claude/skills/js-fp-wordpress/SKILL.md +301 -0
- package/plugins/ima-claude/skills/js-fp-wordpress/references/ajax-patterns.md +192 -0
- package/plugins/ima-claude/skills/js-fp-wordpress/references/event-patterns.md +136 -0
- package/plugins/ima-claude/skills/js-fp-wordpress/references/wp-integration.md +248 -0
- package/plugins/ima-claude/skills/livecanvas/SKILL.md +209 -0
- package/plugins/ima-claude/skills/livecanvas/references/livecanvas-features.md +311 -0
- package/plugins/ima-claude/skills/livecanvas/references/loops-and-logic.md +730 -0
- package/plugins/ima-claude/skills/livecanvas/references/picostrap.md +227 -0
- package/plugins/ima-claude/skills/mcp-atlassian/SKILL.md +339 -0
- package/plugins/ima-claude/skills/mcp-context7/SKILL.md +109 -0
- package/plugins/ima-claude/skills/mcp-memory/SKILL.md +182 -0
- package/plugins/ima-claude/skills/mcp-qdrant/SKILL.md +233 -0
- package/plugins/ima-claude/skills/mcp-sequential/SKILL.md +149 -0
- package/plugins/ima-claude/skills/mcp-serena/SKILL.md +174 -0
- package/plugins/ima-claude/skills/mcp-tavily/SKILL.md +118 -0
- package/plugins/ima-claude/skills/mcp-vestige/SKILL.md +259 -0
- package/plugins/ima-claude/skills/php-authnet/SKILL.md +275 -0
- package/plugins/ima-claude/skills/php-authnet/references/api-reference.md +624 -0
- package/plugins/ima-claude/skills/php-authnet/references/sandbox-testing.md +424 -0
- package/plugins/ima-claude/skills/php-fp/SKILL.md +333 -0
- package/plugins/ima-claude/skills/php-fp/examples/pure-functions.php +403 -0
- package/plugins/ima-claude/skills/php-fp/examples/tests/PureFunctionsTest.php +515 -0
- package/plugins/ima-claude/skills/php-fp/references/core-principles.md +277 -0
- package/plugins/ima-claude/skills/php-fp/references/testing-patterns.md +374 -0
- package/plugins/ima-claude/skills/php-fp-wordpress/SKILL.md +216 -0
- package/plugins/ima-claude/skills/php-fp-wordpress/references/fp-patterns.md +275 -0
- package/plugins/ima-claude/skills/php-fp-wordpress/references/plugin-architecture.md +295 -0
- package/plugins/ima-claude/skills/php-fp-wordpress/references/security-examples.md +203 -0
- package/plugins/ima-claude/skills/php-fp-wordpress/references/testing-strategy.md +259 -0
- package/plugins/ima-claude/skills/phpunit-wp/SKILL.md +716 -0
- package/plugins/ima-claude/skills/playwright/SKILL.md +434 -0
- package/plugins/ima-claude/skills/playwright/references/accessibility-testing.md +153 -0
- package/plugins/ima-claude/skills/playwright/references/ci-cd.md +268 -0
- package/plugins/ima-claude/skills/playwright/references/network-mocking.md +270 -0
- package/plugins/ima-claude/skills/playwright/references/visual-regression.md +215 -0
- package/plugins/ima-claude/skills/py-fp/SKILL.md +663 -0
- package/plugins/ima-claude/skills/py-fp/examples/pure-functions.py +185 -0
- package/plugins/ima-claude/skills/py-fp/examples/tests/test_pure_functions.py +244 -0
- package/plugins/ima-claude/skills/py-fp/references/core-principles.md +381 -0
- package/plugins/ima-claude/skills/py-fp/references/testing-patterns.md +283 -0
- package/plugins/ima-claude/skills/quasar-fp/SKILL.md +327 -0
- package/plugins/ima-claude/skills/quasar-fp/metadata.json +85 -0
- package/plugins/ima-claude/skills/quasar-fp/references/component-patterns.md +257 -0
- package/plugins/ima-claude/skills/quasar-fp/references/theme-integration.md +233 -0
- package/plugins/ima-claude/skills/quasar-fp/references/utility-classes.md +237 -0
- package/plugins/ima-claude/skills/quickstart/SKILL.md +129 -0
- package/plugins/ima-claude/skills/rails/SKILL.md +359 -0
- package/plugins/ima-claude/skills/resume-session/SKILL.md +68 -0
- package/plugins/ima-claude/skills/rg/SKILL.md +205 -0
- package/plugins/ima-claude/skills/ruby-fp/SKILL.md +336 -0
- package/plugins/ima-claude/skills/save-session/SKILL.md +81 -0
- package/plugins/ima-claude/skills/scorecard/SKILL.md +96 -0
- package/plugins/ima-claude/skills/skill-analyzer/SKILL.md +127 -0
- package/plugins/ima-claude/skills/skill-analyzer/references/advanced-checklist.md +44 -0
- package/plugins/ima-claude/skills/skill-analyzer/references/core-checklist.md +60 -0
- package/plugins/ima-claude/skills/skill-analyzer/scripts/analyze_skill.py +418 -0
- package/plugins/ima-claude/skills/skill-creator/LICENSE.txt +202 -0
- package/plugins/ima-claude/skills/skill-creator/SKILL.md +343 -0
- package/plugins/ima-claude/skills/skill-creator/references/output-patterns.md +82 -0
- package/plugins/ima-claude/skills/skill-creator/references/workflows.md +28 -0
- package/plugins/ima-claude/skills/skill-creator/scripts/init_skill.py +303 -0
- package/plugins/ima-claude/skills/skill-creator/scripts/package_skill.py +110 -0
- package/plugins/ima-claude/skills/skill-creator/scripts/quick_validate.py +103 -0
- package/plugins/ima-claude/skills/task-master/SKILL.md +51 -0
- package/plugins/ima-claude/skills/task-planner/SKILL.md +228 -0
- package/plugins/ima-claude/skills/task-runner/SKILL.md +192 -0
- package/plugins/ima-claude/skills/unit-testing/SKILL.md +198 -0
- package/plugins/ima-claude/skills/unit-testing/references/mock-patterns.md +181 -0
- package/plugins/ima-claude/skills/unit-testing/references/tdd-workflow.md +177 -0
- package/plugins/ima-claude/skills/unit-testing/references/test-strategy.md +126 -0
- package/plugins/ima-claude/skills/wp-local/SKILL.md +246 -0
- package/plugins/ima-claude/skills/wp-local/references/configuration.md +198 -0
- package/plugins/ima-claude/skills/wp-local/references/wp-cli-reference.md +406 -0
- package/plugins/ima-claude/skills/wp-local/scripts/wp-local.sh +61 -0
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "docs-organize"
|
|
3
|
+
description: "Three-tier documentation organization system - Active (permanent) | Archive (historical) | Transient (ephemeral, git-ignored)"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Documentation Organization System
|
|
7
|
+
|
|
8
|
+
A structured approach to documentation organization that separates permanent, historical, and ephemeral content with clear navigation and lifecycle management.
|
|
9
|
+
|
|
10
|
+
## When to Use This Skill
|
|
11
|
+
|
|
12
|
+
- Starting a new project and setting up documentation structure
|
|
13
|
+
- Reorganizing existing scattered documentation files
|
|
14
|
+
- Need clear separation between active docs and historical reference
|
|
15
|
+
- Want local-only working documents that won't clutter git
|
|
16
|
+
- Improving documentation discoverability and navigation
|
|
17
|
+
- Establishing documentation standards for a team
|
|
18
|
+
|
|
19
|
+
## Core Philosophy
|
|
20
|
+
|
|
21
|
+
**Three-Tier Documentation**:
|
|
22
|
+
- **Active**: Current, permanent documentation used daily (committed to git)
|
|
23
|
+
- **Archive**: Historical reference, completed phases, deprecated patterns (committed to git)
|
|
24
|
+
- **Transient**: Ephemeral working documents, investigation logs, spike results (git-ignored)
|
|
25
|
+
|
|
26
|
+
**Key Principles**:
|
|
27
|
+
- **Clear Lifecycle**: Documents flow from transient → active → archive
|
|
28
|
+
- **Theme Organization**: Group by function (architecture, development, integrations, features, operations)
|
|
29
|
+
- **Navigation First**: README files at every level for discoverability
|
|
30
|
+
- **Minimal Clutter**: Root directory stays clean, no scattered MD files
|
|
31
|
+
|
|
32
|
+
## Folder Structure
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
docs/
|
|
36
|
+
├── README.md # Central navigation hub
|
|
37
|
+
├── active/ # Current permanent documentation
|
|
38
|
+
│ ├── README.md # Active docs overview
|
|
39
|
+
│ ├── architecture/ # System design, plugins, dependencies
|
|
40
|
+
│ │ └── README.md
|
|
41
|
+
│ ├── development/ # Testing, code standards, patterns
|
|
42
|
+
│ │ ├── README.md
|
|
43
|
+
│ │ └── testing-guides/ # Phase-specific test suites
|
|
44
|
+
│ ├── integrations/ # Third-party system connections
|
|
45
|
+
│ │ ├── README.md
|
|
46
|
+
│ │ └── [integration-name]/ # Per-integration documentation
|
|
47
|
+
│ ├── features/ # Feature-specific documentation
|
|
48
|
+
│ │ └── [feature-name]/ # Per-feature documentation
|
|
49
|
+
│ ├── operations/ # Security, troubleshooting, deployment
|
|
50
|
+
│ │ └── README.md
|
|
51
|
+
│ └── reference/ # Templates, quick commands, standards
|
|
52
|
+
│ └── README.md
|
|
53
|
+
├── archive/ # Historical documentation
|
|
54
|
+
│ ├── README.md # Archive overview & browsing guide
|
|
55
|
+
│ └── [YYYY-phase-name]/ # Completed phases/milestones
|
|
56
|
+
│ └── README.md # Phase summary with outcomes
|
|
57
|
+
└── transient/ # Ephemeral working documents
|
|
58
|
+
├── .gitignore # Excludes *.md from git
|
|
59
|
+
└── README.md # Transient usage guide
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Implementation Guide
|
|
63
|
+
|
|
64
|
+
### Step 1: Create Folder Structure
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
# Create main structure
|
|
68
|
+
mkdir -p docs/{active,archive,transient}
|
|
69
|
+
|
|
70
|
+
# Create active subdirectories
|
|
71
|
+
mkdir -p docs/active/{architecture,development,integrations,features,operations,reference}
|
|
72
|
+
mkdir -p docs/active/development/testing-guides
|
|
73
|
+
|
|
74
|
+
# Create .gitignore for transient
|
|
75
|
+
echo '# Exclude all markdown files in transient/
|
|
76
|
+
*.md
|
|
77
|
+
!README.md' > docs/transient/.gitignore
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Step 2: Create Navigation Hub (docs/README.md)
|
|
81
|
+
|
|
82
|
+
Use template: [`templates/docs-README.md`](templates/docs-README.md)
|
|
83
|
+
|
|
84
|
+
Customize the Quick Navigation table for your project's key files.
|
|
85
|
+
|
|
86
|
+
### Step 3: Create Active Section README (docs/active/README.md)
|
|
87
|
+
|
|
88
|
+
Use template: [`templates/active-README.md`](templates/active-README.md)
|
|
89
|
+
|
|
90
|
+
### Step 4: Create Archive README (docs/archive/README.md)
|
|
91
|
+
|
|
92
|
+
Use template: [`templates/archive-README.md`](templates/archive-README.md)
|
|
93
|
+
|
|
94
|
+
For completed phases, use: [`templates/phase-archive-README.md`](templates/phase-archive-README.md)
|
|
95
|
+
|
|
96
|
+
### Step 5: Create Transient README and .gitignore
|
|
97
|
+
|
|
98
|
+
- **docs/transient/README.md**: Use [`templates/transient-README.md`](templates/transient-README.md)
|
|
99
|
+
- **docs/transient/.gitignore**: Use [`templates/transient-gitignore`](templates/transient-gitignore)
|
|
100
|
+
|
|
101
|
+
### Step 6: Create Section READMEs
|
|
102
|
+
|
|
103
|
+
For each `active/` subdirectory, use: [`templates/section-README.md`](templates/section-README.md)
|
|
104
|
+
|
|
105
|
+
## Document Lifecycle Workflow
|
|
106
|
+
|
|
107
|
+
```
|
|
108
|
+
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
|
109
|
+
│ TRANSIENT │ ──▶ │ ACTIVE │ ──▶ │ ARCHIVE │
|
|
110
|
+
│ │ │ │ │ │
|
|
111
|
+
│ • Planning │ │ • Stable │ │ • Complete │
|
|
112
|
+
│ • Research │ │ • Reference │ │ • Historical│
|
|
113
|
+
│ • Spikes │ │ • Standards │ │ • Deprecated│
|
|
114
|
+
└─────────────┘ └─────────────┘ └─────────────┘
|
|
115
|
+
git-ignored committed committed
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### Lifecycle Triggers
|
|
119
|
+
|
|
120
|
+
**Transient → Active**:
|
|
121
|
+
- Planning becomes implementation guide
|
|
122
|
+
- Investigation findings become troubleshooting docs
|
|
123
|
+
- Spike results become architecture decisions
|
|
124
|
+
|
|
125
|
+
**Active → Archive**:
|
|
126
|
+
- Phase/milestone completed
|
|
127
|
+
- Feature deprecated with replacement
|
|
128
|
+
- Pattern replaced with better approach
|
|
129
|
+
|
|
130
|
+
**Direct to Archive** (skip transient):
|
|
131
|
+
- Completed work documentation
|
|
132
|
+
- Phase summaries with outcomes
|
|
133
|
+
- Historical code reviews
|
|
134
|
+
|
|
135
|
+
## Theme Categories Reference
|
|
136
|
+
|
|
137
|
+
### `architecture/`
|
|
138
|
+
- Plugin/module architecture
|
|
139
|
+
- Dependency management
|
|
140
|
+
- System design decisions
|
|
141
|
+
- Refactoring roadmaps
|
|
142
|
+
|
|
143
|
+
### `development/`
|
|
144
|
+
- Testing infrastructure (PHPUnit, Jest, etc.)
|
|
145
|
+
- Code examples and patterns
|
|
146
|
+
- Development standards
|
|
147
|
+
- Template patterns
|
|
148
|
+
|
|
149
|
+
### `integrations/`
|
|
150
|
+
- Third-party API connections
|
|
151
|
+
- Webhook handling
|
|
152
|
+
- Data sync patterns
|
|
153
|
+
- Authentication flows
|
|
154
|
+
|
|
155
|
+
### `features/`
|
|
156
|
+
- Feature-specific documentation
|
|
157
|
+
- User workflows
|
|
158
|
+
- Configuration options
|
|
159
|
+
- Feature flags
|
|
160
|
+
|
|
161
|
+
### `operations/`
|
|
162
|
+
- Security best practices
|
|
163
|
+
- Troubleshooting guides
|
|
164
|
+
- Deployment procedures
|
|
165
|
+
- Monitoring setup
|
|
166
|
+
|
|
167
|
+
### `reference/`
|
|
168
|
+
- Quick command cheatsheets
|
|
169
|
+
- Template files
|
|
170
|
+
- Brand/style guidelines
|
|
171
|
+
- Onboarding materials
|
|
172
|
+
|
|
173
|
+
## Quality Gates
|
|
174
|
+
|
|
175
|
+
Before adding documentation, verify:
|
|
176
|
+
|
|
177
|
+
1. ✅ **Correct Location**: Active vs. Archive vs. Transient
|
|
178
|
+
2. ✅ **Theme Match**: Right subdirectory for the content
|
|
179
|
+
3. ✅ **Navigation Updated**: README links added
|
|
180
|
+
4. ✅ **Cross-References**: Related docs linked
|
|
181
|
+
5. ✅ **Date Included**: "Last Updated" at bottom
|
|
182
|
+
6. ✅ **Naming Convention**: UPPER_SNAKE_CASE.md or lowercase-kebab/
|
|
183
|
+
|
|
184
|
+
## Migration Checklist
|
|
185
|
+
|
|
186
|
+
When applying this pattern to existing projects:
|
|
187
|
+
|
|
188
|
+
- [ ] Create folder structure with `mkdir -p` commands
|
|
189
|
+
- [ ] Create `.gitignore` in transient/
|
|
190
|
+
- [ ] Create hub README at `docs/README.md`
|
|
191
|
+
- [ ] Create section READMEs in each active/ subdirectory
|
|
192
|
+
- [ ] Create archive README with naming conventions
|
|
193
|
+
- [ ] Create transient README with workflow guidance
|
|
194
|
+
- [ ] Move existing documentation to appropriate locations
|
|
195
|
+
- [ ] Update project CLAUDE.md/README.md references
|
|
196
|
+
- [ ] Verify all internal links work
|
|
197
|
+
- [ ] Clean up root-level scattered MD files
|
|
198
|
+
|
|
199
|
+
## Integration with Project Files
|
|
200
|
+
|
|
201
|
+
### Update Root CLAUDE.md
|
|
202
|
+
|
|
203
|
+
Add documentation hub reference:
|
|
204
|
+
```markdown
|
|
205
|
+
**📚 Key Documentation:**
|
|
206
|
+
- **[📖 Documentation Index](docs/README.md)** - Central hub for all documentation
|
|
207
|
+
- [Testing Guide](docs/active/development/testing-guides/) - Test setup
|
|
208
|
+
- [Architecture](docs/active/architecture/) - System design
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Update Navigation References
|
|
212
|
+
|
|
213
|
+
Change scattered references from:
|
|
214
|
+
```markdown
|
|
215
|
+
[Testing](TESTING.md)
|
|
216
|
+
[Security](docs/SECURITY_GUIDE.md)
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
To centralized structure:
|
|
220
|
+
```markdown
|
|
221
|
+
[Testing](docs/active/development/testing-guides/TESTING.md)
|
|
222
|
+
[Security](docs/active/operations/SECURITY_GUIDE.md)
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
## Success Metrics
|
|
226
|
+
|
|
227
|
+
Documentation organization is successful when:
|
|
228
|
+
|
|
229
|
+
- **Discoverability**: New team members find docs within 2 clicks from hub
|
|
230
|
+
- **Cleanliness**: Root directory has no scattered MD files
|
|
231
|
+
- **Currency**: Active docs are up-to-date with implementation
|
|
232
|
+
- **Lifecycle**: Clear workflow from planning to archive
|
|
233
|
+
- **Navigation**: README at every level provides guidance
|
|
234
|
+
|
|
235
|
+
## Anti-Patterns to Avoid
|
|
236
|
+
|
|
237
|
+
❌ **Scattered root files**: MD files in project root instead of /docs/
|
|
238
|
+
❌ **Flat structure**: All docs in single /docs/ folder without themes
|
|
239
|
+
❌ **Missing READMEs**: Subdirectories without navigation guides
|
|
240
|
+
❌ **Broken links**: References to moved/deleted files
|
|
241
|
+
❌ **Stale transient**: Investigation logs never cleaned up
|
|
242
|
+
❌ **Over-archiving**: Active docs moved to archive prematurely
|
|
243
|
+
❌ **Under-archiving**: Completed phase docs never archived
|
|
244
|
+
|
|
245
|
+
## Related Patterns
|
|
246
|
+
|
|
247
|
+
- **CLAUDE.md**: Project-level quick reference (references this structure)
|
|
248
|
+
- **ADR (Architecture Decision Records)**: Can live in `active/architecture/adr/`
|
|
249
|
+
- **Changelogs**: Can live in `active/reference/CHANGELOG.md`
|
|
250
|
+
- **API Documentation**: Can live in `active/reference/api/`
|
|
251
|
+
|
|
252
|
+
---
|
|
253
|
+
|
|
254
|
+
**Last Updated**: 2025-01-20
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Active Documentation
|
|
2
|
+
|
|
3
|
+
Current, maintained documentation for daily development and reference.
|
|
4
|
+
|
|
5
|
+
## Sections
|
|
6
|
+
|
|
7
|
+
### [`architecture/`](architecture/)
|
|
8
|
+
System design documents, plugin ecosystem, dependencies, refactoring strategy.
|
|
9
|
+
|
|
10
|
+
### [`development/`](development/)
|
|
11
|
+
Testing infrastructure, code examples, development patterns, standards.
|
|
12
|
+
|
|
13
|
+
### [`integrations/`](integrations/)
|
|
14
|
+
Third-party system integration documentation and patterns.
|
|
15
|
+
|
|
16
|
+
### [`features/`](features/)
|
|
17
|
+
Feature-specific documentation organized by feature name.
|
|
18
|
+
|
|
19
|
+
### [`operations/`](operations/)
|
|
20
|
+
Security guides, troubleshooting, deployment procedures.
|
|
21
|
+
|
|
22
|
+
### [`reference/`](reference/)
|
|
23
|
+
Quick reference materials, templates, command cheatsheets.
|
|
24
|
+
|
|
25
|
+
## Key Files
|
|
26
|
+
|
|
27
|
+
| File | Purpose |
|
|
28
|
+
|------|---------|
|
|
29
|
+
| `architecture/SYSTEM_DESIGN.md` | Overall system architecture |
|
|
30
|
+
| `development/TESTING.md` | Testing setup and patterns |
|
|
31
|
+
| `operations/SECURITY_GUIDE.md` | Security best practices |
|
|
32
|
+
|
|
33
|
+
## Documentation Standards
|
|
34
|
+
|
|
35
|
+
- **Should be current**: Review quarterly, update when implementation changes
|
|
36
|
+
- **Should include examples**: Real code from the codebase
|
|
37
|
+
- **Should link to related docs**: Cross-reference architecture, features, operations
|
|
38
|
+
|
|
39
|
+
## When to Add Here vs. Transient
|
|
40
|
+
|
|
41
|
+
| Add to Active | Add to Transient |
|
|
42
|
+
|---------------|------------------|
|
|
43
|
+
| Stable implementation docs | Investigation logs |
|
|
44
|
+
| Permanent reference material | Spike/POC results |
|
|
45
|
+
| Team knowledge base | Phase planning notes |
|
|
46
|
+
| Onboarding materials | Temporary checklists |
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
**Last Updated**: YYYY-MM-DD
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Documentation Archive
|
|
2
|
+
|
|
3
|
+
Historical documentation, completed phases, and deprecated patterns.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
This archive serves as:
|
|
8
|
+
- **Historical context** for understanding past decisions
|
|
9
|
+
- **Learning resource** for patterns that worked (or didn't)
|
|
10
|
+
- **Audit trail** for project evolution
|
|
11
|
+
|
|
12
|
+
## Archive Contents
|
|
13
|
+
|
|
14
|
+
### Completed Phases
|
|
15
|
+
|
|
16
|
+
| Phase | Period | Summary |
|
|
17
|
+
|-------|--------|---------|
|
|
18
|
+
| *Example: Phase 1* | *YYYY-MM* | *Brief description of what was completed* |
|
|
19
|
+
|
|
20
|
+
## Archive Naming Convention
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
YYYY-phase-name/ # Completed development phases
|
|
24
|
+
YYYY-MM-feature-name/ # Deprecated feature documentation
|
|
25
|
+
deprecated-pattern-name/ # Replaced patterns with migration notes
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## When to Archive
|
|
29
|
+
|
|
30
|
+
| Archive When | Don't Archive |
|
|
31
|
+
|--------------|---------------|
|
|
32
|
+
| Phase/milestone complete | Still actively referenced |
|
|
33
|
+
| Pattern deprecated with replacement | Needed for current development |
|
|
34
|
+
| Historical reference value | No future reference value (delete instead) |
|
|
35
|
+
|
|
36
|
+
## Browsing Tips
|
|
37
|
+
|
|
38
|
+
- Start with the phase README for summary
|
|
39
|
+
- Look for "What Was Done" and "Lessons Learned" sections
|
|
40
|
+
- Check cross-references to current active docs
|
|
41
|
+
|
|
42
|
+
## Creating Archive Entries
|
|
43
|
+
|
|
44
|
+
When archiving completed work:
|
|
45
|
+
|
|
46
|
+
1. Create folder with naming convention: `YYYY-phase-name/`
|
|
47
|
+
2. Create `README.md` with:
|
|
48
|
+
- What Was Done
|
|
49
|
+
- Key Outcomes
|
|
50
|
+
- Lessons Learned
|
|
51
|
+
- Links to related active docs
|
|
52
|
+
3. Move relevant historical files into the folder
|
|
53
|
+
4. Update this README's contents table
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
**Last Updated**: YYYY-MM-DD
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Project Documentation
|
|
2
|
+
|
|
3
|
+
Central hub for all project documentation.
|
|
4
|
+
|
|
5
|
+
## 📂 Documentation Structure
|
|
6
|
+
|
|
7
|
+
### [`active/`](active/README.md) - Current Documentation ⭐
|
|
8
|
+
Active, maintained documentation used in daily development.
|
|
9
|
+
**All files committed to git.**
|
|
10
|
+
|
|
11
|
+
- **[architecture/](active/architecture/)** - System design, plugins, dependencies
|
|
12
|
+
- **[development/](active/development/)** - Testing, code standards, patterns
|
|
13
|
+
- **[integrations/](active/integrations/)** - Third-party integrations
|
|
14
|
+
- **[features/](active/features/)** - Feature-specific documentation
|
|
15
|
+
- **[operations/](active/operations/)** - Security, troubleshooting, deployment
|
|
16
|
+
- **[reference/](active/reference/)** - Templates, quick commands
|
|
17
|
+
|
|
18
|
+
### [`archive/`](archive/README.md) - Historical Reference 📚
|
|
19
|
+
Completed phases, deprecated patterns, historical context.
|
|
20
|
+
**Committed to git for reference.**
|
|
21
|
+
|
|
22
|
+
### [`transient/`](transient/) - Working Documents 🚧
|
|
23
|
+
Local-only ephemeral documents for investigation and planning.
|
|
24
|
+
**Git-ignored, not committed.**
|
|
25
|
+
|
|
26
|
+
## Quick Navigation
|
|
27
|
+
|
|
28
|
+
| Category | Key Files | Purpose |
|
|
29
|
+
|----------|-----------|---------|
|
|
30
|
+
| Development | [Testing Guide](active/development/testing-guides/) | Test setup and patterns |
|
|
31
|
+
| Architecture | [System Design](active/architecture/) | Architecture decisions |
|
|
32
|
+
| Operations | [Security](active/operations/) | Security best practices |
|
|
33
|
+
|
|
34
|
+
## Documentation Standards
|
|
35
|
+
|
|
36
|
+
- **Naming**: `UPPER_SNAKE_CASE.md` for documents, `lowercase-kebab/` for folders
|
|
37
|
+
- **Cross-References**: Always link to related documentation
|
|
38
|
+
- **Last Updated**: Include date at bottom of each document
|
|
39
|
+
- **Structure**: Use consistent heading hierarchy (H1 title, H2 sections)
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
**Last Updated**: YYYY-MM-DD
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Phase Name: [Description]
|
|
2
|
+
|
|
3
|
+
**Period**: YYYY-MM to YYYY-MM
|
|
4
|
+
**Status**: ✅ Complete
|
|
5
|
+
**Focus**: Brief description of what this phase accomplished
|
|
6
|
+
|
|
7
|
+
## What Was Done
|
|
8
|
+
|
|
9
|
+
### 1. [Major Change Category]
|
|
10
|
+
**File(s)**: `path/to/affected/files`
|
|
11
|
+
|
|
12
|
+
**Changes:**
|
|
13
|
+
- ✅ Change description 1
|
|
14
|
+
- ✅ Change description 2
|
|
15
|
+
- ❌ Removed: deprecated feature
|
|
16
|
+
|
|
17
|
+
**Before:**
|
|
18
|
+
```
|
|
19
|
+
Brief description or code sample of previous state
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**After:**
|
|
23
|
+
```
|
|
24
|
+
Brief description or code sample of new state
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### 2. [Another Major Change]
|
|
28
|
+
...
|
|
29
|
+
|
|
30
|
+
## Key Outcomes
|
|
31
|
+
|
|
32
|
+
- **Result 1**: Quantifiable outcome (e.g., "-34 lines of code")
|
|
33
|
+
- **Result 2**: Qualitative outcome (e.g., "simplified hook flow")
|
|
34
|
+
- **Result 3**: User impact (e.g., "faster page load times")
|
|
35
|
+
|
|
36
|
+
## Testing Completed
|
|
37
|
+
|
|
38
|
+
- ✅ Test category 1
|
|
39
|
+
- ✅ Test category 2
|
|
40
|
+
- ✅ Regression testing
|
|
41
|
+
|
|
42
|
+
**Test Documentation:** [`active/development/testing-guides/TESTING_PHASE_X.md`](../../active/development/testing-guides/TESTING_PHASE_X.md)
|
|
43
|
+
|
|
44
|
+
## Lessons Learned
|
|
45
|
+
|
|
46
|
+
### What Worked Well
|
|
47
|
+
- Approach that succeeded
|
|
48
|
+
- Tool/pattern that helped
|
|
49
|
+
|
|
50
|
+
### What Could Be Improved
|
|
51
|
+
- Challenge faced
|
|
52
|
+
- Future consideration
|
|
53
|
+
|
|
54
|
+
## Dependencies Changed
|
|
55
|
+
|
|
56
|
+
**Removed:**
|
|
57
|
+
- ❌ Dependency that was removed
|
|
58
|
+
|
|
59
|
+
**Added:**
|
|
60
|
+
- ✅ New dependency (reason for addition)
|
|
61
|
+
|
|
62
|
+
## Related Documentation
|
|
63
|
+
|
|
64
|
+
**Current Active Docs:**
|
|
65
|
+
- [`active/integrations/`](../../active/integrations/) - Current integration patterns
|
|
66
|
+
- [`active/architecture/`](../../active/architecture/) - Updated architecture
|
|
67
|
+
|
|
68
|
+
**Historical Reference:**
|
|
69
|
+
- `HISTORICAL_DOC.md` - Pre-phase documentation (in this folder)
|
|
70
|
+
|
|
71
|
+
## What's Next
|
|
72
|
+
|
|
73
|
+
**Phase N+1**: Brief description of upcoming work
|
|
74
|
+
- Planned task 1
|
|
75
|
+
- Planned task 2
|
|
76
|
+
|
|
77
|
+
See [`active/architecture/ROADMAP.md`](../../active/architecture/ROADMAP.md) for planning details.
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
**Phase Outcome**: ✅ Brief summary of overall success/completion status
|
|
82
|
+
|
|
83
|
+
**Last Updated**: YYYY-MM-DD
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# [Section Name] Documentation
|
|
2
|
+
|
|
3
|
+
Brief description of what this section contains.
|
|
4
|
+
|
|
5
|
+
## Core Documents
|
|
6
|
+
|
|
7
|
+
### [`DOCUMENT_NAME.md`](DOCUMENT_NAME.md)
|
|
8
|
+
**Purpose description.**
|
|
9
|
+
|
|
10
|
+
Key topics:
|
|
11
|
+
- Topic 1
|
|
12
|
+
- Topic 2
|
|
13
|
+
- Topic 3
|
|
14
|
+
|
|
15
|
+
### `COMING_SOON.md` (Coming Soon)
|
|
16
|
+
**Planned document description.**
|
|
17
|
+
|
|
18
|
+
Will cover:
|
|
19
|
+
- Planned topic 1
|
|
20
|
+
- Planned topic 2
|
|
21
|
+
|
|
22
|
+
## Subdirectories
|
|
23
|
+
|
|
24
|
+
### [`subdirectory-name/`](subdirectory-name/)
|
|
25
|
+
Description of subdirectory contents.
|
|
26
|
+
|
|
27
|
+
## Quick Reference
|
|
28
|
+
|
|
29
|
+
| Document | Purpose | Audience |
|
|
30
|
+
|----------|---------|----------|
|
|
31
|
+
| `DOC_1.md` | Purpose | Developers |
|
|
32
|
+
| `DOC_2.md` | Purpose | Operations |
|
|
33
|
+
|
|
34
|
+
## Related Documentation
|
|
35
|
+
|
|
36
|
+
- **[Related Section 1](../related-section/)** - How it relates
|
|
37
|
+
- **[Related Section 2](../another-section/)** - How it relates
|
|
38
|
+
- **[Archive](../../archive/)** - Historical context
|
|
39
|
+
|
|
40
|
+
## Standards
|
|
41
|
+
|
|
42
|
+
Brief notes on standards specific to this section:
|
|
43
|
+
- Standard 1
|
|
44
|
+
- Standard 2
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
**Last Updated**: YYYY-MM-DD
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Transient Documentation
|
|
2
|
+
|
|
3
|
+
Ephemeral local-only documents for active planning and investigation.
|
|
4
|
+
|
|
5
|
+
**⚠️ Files here are git-ignored and will NOT be committed.**
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
|
|
9
|
+
Use transient/ for:
|
|
10
|
+
- **Phase planning** before implementation starts
|
|
11
|
+
- **Investigation logs** during debugging
|
|
12
|
+
- **Spike results** from technical exploration
|
|
13
|
+
- **Collaborative notes** during pairing sessions
|
|
14
|
+
- **Temporary checklists** for one-time tasks
|
|
15
|
+
|
|
16
|
+
## Organization Suggestions
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
transient/
|
|
20
|
+
├── planning/ # Upcoming phase/feature planning
|
|
21
|
+
├── investigations/ # Debug sessions, root cause analysis
|
|
22
|
+
├── spikes/ # Technical explorations, POCs
|
|
23
|
+
└── notes/ # Miscellaneous working notes
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Workflow
|
|
27
|
+
|
|
28
|
+
### Creating Transient Docs
|
|
29
|
+
1. Create file in appropriate subfolder
|
|
30
|
+
2. Include date in filename: `YYYY-MM-DD-topic.md`
|
|
31
|
+
3. Work locally, iterate freely
|
|
32
|
+
|
|
33
|
+
### Moving to Active
|
|
34
|
+
When a transient doc becomes stable:
|
|
35
|
+
1. Clean up content for permanence
|
|
36
|
+
2. Move to appropriate `active/` section
|
|
37
|
+
3. Delete original transient file
|
|
38
|
+
4. Update navigation links
|
|
39
|
+
|
|
40
|
+
### Cleanup
|
|
41
|
+
- Review transient/ monthly
|
|
42
|
+
- Delete completed investigation logs
|
|
43
|
+
- Archive useful findings to `active/` or `archive/`
|
|
44
|
+
|
|
45
|
+
## Example: Investigation Log
|
|
46
|
+
|
|
47
|
+
```markdown
|
|
48
|
+
# 2025-01-20 - API Performance Investigation
|
|
49
|
+
|
|
50
|
+
## Symptoms
|
|
51
|
+
- API response times >2s on listing endpoint
|
|
52
|
+
- Database queries showing N+1 pattern
|
|
53
|
+
|
|
54
|
+
## Investigation Steps
|
|
55
|
+
1. Added timing logs to endpoint
|
|
56
|
+
2. Identified 47 individual queries per request
|
|
57
|
+
3. Found missing `update_meta_cache()` call
|
|
58
|
+
|
|
59
|
+
## Resolution
|
|
60
|
+
- Added batch meta loading
|
|
61
|
+
- Response time reduced to 150ms
|
|
62
|
+
|
|
63
|
+
## Outcome
|
|
64
|
+
→ Move findings to `active/operations/TROUBLESHOOTING.md`
|
|
65
|
+
→ Delete this investigation log
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Git Behavior
|
|
69
|
+
|
|
70
|
+
This folder contains a `.gitignore` that excludes all `*.md` files.
|
|
71
|
+
|
|
72
|
+
**To force-add a file** (rare, for intentional commits):
|
|
73
|
+
```bash
|
|
74
|
+
git add -f docs/transient/important-file.md
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
**Last Updated**: YYYY-MM-DD
|