5ad0700b41
Restructured project from nested workspace pattern to flat single-repo layout. This eliminates redundant nesting and consolidates all project files under version control. ## Migration Summary **Before:** ``` alex/ (workspace, not versioned) ├── chess-game/ (git repo) │ ├── js/, css/, tests/ │ └── index.html └── docs/ (planning, not versioned) ``` **After:** ``` alex/ (git repo, everything versioned) ├── js/, css/, tests/ ├── index.html ├── docs/ (project documentation) ├── planning/ (historical planning docs) ├── .gitea/ (CI/CD) └── CLAUDE.md (configuration) ``` ## Changes Made ### Structure Consolidation - Moved all chess-game/ contents to root level - Removed redundant chess-game/ subdirectory - Flattened directory structure (eliminated one nesting level) ### Documentation Organization - Moved chess-game/docs/ → docs/ (project documentation) - Moved alex/docs/ → planning/ (historical planning documents) - Added CLAUDE.md (workspace configuration) - Added IMPLEMENTATION_PROMPT.md (original project prompt) ### Version Control Improvements - All project files now under version control - Planning documents preserved in planning/ folder - Merged .gitignore files (workspace + project) - Added .claude/ agent configurations ### File Updates - Updated .gitignore to include both workspace and project excludes - Moved README.md to root level - All import paths remain functional (relative paths unchanged) ## Benefits ✅ **Simpler Structure** - One level of nesting removed ✅ **Complete Versioning** - All documentation now in git ✅ **Standard Layout** - Matches open-source project conventions ✅ **Easier Navigation** - Direct access to all project files ✅ **CI/CD Compatible** - All workflows still functional ## Technical Validation - ✅ Node.js environment verified - ✅ Dependencies installed successfully - ✅ Dev server starts and responds - ✅ All core files present and accessible - ✅ Git repository functional ## Files Preserved **Implementation Files:** - js/ (3,517 lines of code) - css/ (4 stylesheets) - tests/ (87 test cases) - index.html - package.json **CI/CD Pipeline:** - .gitea/workflows/ci.yml - .gitea/workflows/release.yml **Documentation:** - docs/ (12+ documentation files) - planning/ (historical planning materials) - README.md **Configuration:** - jest.config.js, babel.config.cjs, playwright.config.js - .gitignore (merged) - CLAUDE.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
55 lines
1.1 KiB
Markdown
55 lines
1.1 KiB
Markdown
# SPARC Documenter Mode
|
|
|
|
## Purpose
|
|
Documentation with batch file operations for comprehensive docs.
|
|
|
|
## Activation
|
|
|
|
### Option 1: Using MCP Tools (Preferred in Claude Code)
|
|
```javascript
|
|
mcp__claude-flow__sparc_mode {
|
|
mode: "documenter",
|
|
task_description: "create API documentation",
|
|
options: {
|
|
format: "markdown",
|
|
include_examples: true
|
|
}
|
|
}
|
|
```
|
|
|
|
### Option 2: Using NPX CLI (Fallback when MCP not available)
|
|
```bash
|
|
# Use when running from terminal or MCP tools unavailable
|
|
npx claude-flow sparc run documenter "create API documentation"
|
|
|
|
# For alpha features
|
|
npx claude-flow@alpha sparc run documenter "create API documentation"
|
|
```
|
|
|
|
### Option 3: Local Installation
|
|
```bash
|
|
# If claude-flow is installed locally
|
|
./claude-flow sparc run documenter "create API documentation"
|
|
```
|
|
|
|
## Core Capabilities
|
|
- API documentation
|
|
- Code documentation
|
|
- User guides
|
|
- Architecture docs
|
|
- README files
|
|
|
|
## Documentation Types
|
|
- Markdown documentation
|
|
- JSDoc comments
|
|
- API specifications
|
|
- Integration guides
|
|
- Deployment docs
|
|
|
|
## Batch Features
|
|
- Parallel doc generation
|
|
- Bulk file updates
|
|
- Cross-reference management
|
|
- Example generation
|
|
- Diagram creation
|