myaidev-method 0.2.5 → 0.2.6
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/USER_GUIDE.md +389 -8
- package/bin/cli.js +161 -70
- package/package.json +1 -1
- package/src/lib/ascii-banner.js +100 -0
- package/src/templates/claude/commands/myai-deploy-dev.md +500 -0
- package/src/templates/claude/commands/myai-deploy-prod.md +837 -0
- package/src/templates/claude/commands/myai-deploy-staging.md +331 -0
- package/src/templates/claude/commands/myai-git-hotfix.md +957 -0
- package/src/templates/claude/commands/myai-git-pr.md +200 -0
- package/src/templates/claude/commands/myai-git-release.md +806 -0
- package/src/templates/claude/commands/myai-git-sync.md +796 -0
- package/src/templates/codex/commands/myai-astro-publish.md +51 -0
- package/src/templates/codex/commands/myai-configure.md +185 -0
- package/src/templates/codex/commands/myai-content-writer.md +73 -0
- package/src/templates/codex/commands/myai-coolify-deploy.md +159 -0
- package/src/templates/codex/commands/myai-deploy-dev.md +379 -0
- package/src/templates/codex/commands/myai-deploy-prod.md +431 -0
- package/src/templates/codex/commands/myai-deploy-staging.md +275 -0
- package/src/templates/codex/commands/myai-dev-architect.md +69 -0
- package/src/templates/codex/commands/myai-dev-code.md +82 -0
- package/src/templates/codex/commands/myai-dev-docs.md +83 -0
- package/src/templates/codex/commands/myai-dev-review.md +85 -0
- package/src/templates/codex/commands/myai-dev-test.md +84 -0
- package/src/templates/codex/commands/myai-docusaurus-publish.md +42 -0
- package/src/templates/codex/commands/myai-git-hotfix.md +512 -0
- package/src/templates/codex/commands/myai-git-pr.md +196 -0
- package/src/templates/codex/commands/myai-git-release.md +516 -0
- package/src/templates/codex/commands/myai-git-sync.md +517 -0
- package/src/templates/codex/commands/myai-mintlify-publish.md +42 -0
- package/src/templates/codex/commands/myai-payloadcms-publish.md +42 -0
- package/src/templates/codex/commands/myai-sparc-workflow.md +185 -0
- package/src/templates/codex/commands/myai-wordpress-admin.md +143 -0
- package/src/templates/codex/commands/myai-wordpress-publish.md +66 -0
- package/src/templates/gemini/commands/myai-astro-publish.toml +76 -0
- package/src/templates/gemini/commands/myai-configure.toml +188 -0
- package/src/templates/gemini/commands/myai-content-writer.toml +76 -0
- package/src/templates/gemini/commands/myai-coolify-deploy.toml +138 -0
- package/src/templates/gemini/commands/myai-deploy-dev.toml +379 -0
- package/src/templates/gemini/commands/myai-deploy-prod.toml +438 -0
- package/src/templates/gemini/commands/myai-deploy-staging.toml +275 -0
- package/src/templates/gemini/commands/myai-dev-architect.toml +64 -0
- package/src/templates/gemini/commands/myai-dev-code.toml +75 -0
- package/src/templates/gemini/commands/myai-dev-docs.toml +76 -0
- package/src/templates/gemini/commands/myai-dev-review.toml +78 -0
- package/src/templates/gemini/commands/myai-dev-test.toml +77 -0
- package/src/templates/gemini/commands/myai-docusaurus-publish.toml +63 -0
- package/src/templates/gemini/commands/myai-git-hotfix.toml +953 -0
- package/src/templates/gemini/commands/myai-git-pr.toml +196 -0
- package/src/templates/gemini/commands/myai-git-release.toml +802 -0
- package/src/templates/gemini/commands/myai-git-sync.toml +792 -0
- package/src/templates/gemini/commands/myai-mintlify-publish.toml +67 -0
- package/src/templates/gemini/commands/myai-payloadcms-publish.toml +59 -0
- package/src/templates/gemini/commands/myai-sparc-workflow.toml +47 -0
- package/src/templates/gemini/commands/myai-wordpress-admin.toml +143 -0
- package/src/templates/gemini/commands/myai-wordpress-publish.toml +77 -0
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
prompt = """
|
|
2
|
+
Design scalable system architecture using MyAIDev Method's systematic approach for: {{args}}
|
|
3
|
+
|
|
4
|
+
Invoke the MyAIDev Architect agent to create comprehensive system designs with architecture diagrams, API specifications, and technology recommendations.
|
|
5
|
+
|
|
6
|
+
## What It Does
|
|
7
|
+
|
|
8
|
+
The architect agent will:
|
|
9
|
+
1. Analyze requirements and constraints
|
|
10
|
+
2. Design high-level system architecture
|
|
11
|
+
3. Create component diagrams with Mermaid
|
|
12
|
+
4. Define API specifications and contracts
|
|
13
|
+
5. Plan data models and flows
|
|
14
|
+
6. Recommend appropriate technologies
|
|
15
|
+
7. Document security patterns
|
|
16
|
+
8. Consider scalability and performance
|
|
17
|
+
|
|
18
|
+
## Output
|
|
19
|
+
|
|
20
|
+
Creates `.myaidev-method/sparc/architecture.md` containing:
|
|
21
|
+
- System overview and requirements
|
|
22
|
+
- Architecture diagrams (Mermaid format)
|
|
23
|
+
- Component specifications
|
|
24
|
+
- API contracts and endpoints
|
|
25
|
+
- Data models and schemas
|
|
26
|
+
- Technology stack recommendations
|
|
27
|
+
- Security considerations
|
|
28
|
+
- Scalability planning
|
|
29
|
+
- Deployment architecture
|
|
30
|
+
|
|
31
|
+
## Usage Patterns
|
|
32
|
+
|
|
33
|
+
You can specify:
|
|
34
|
+
- Task description (required) - Clear description of the architecture task
|
|
35
|
+
- --existing-code - Analyze existing codebase before designing
|
|
36
|
+
- --tech-stack <stack> - Specify preferred technology stack (e.g., "node,postgres,redis")
|
|
37
|
+
- --output-dir <path> - Custom output directory (default: `.myaidev-method/sparc/`)
|
|
38
|
+
|
|
39
|
+
## Examples
|
|
40
|
+
|
|
41
|
+
### Design New System
|
|
42
|
+
"Design real-time chat application for 10k concurrent users"
|
|
43
|
+
|
|
44
|
+
### Improve Existing Architecture
|
|
45
|
+
"Review current e-commerce platform and propose performance improvements"
|
|
46
|
+
|
|
47
|
+
### Specify Technology Stack
|
|
48
|
+
"Design microservices architecture --tech-stack node,kubernetes,mongodb,redis"
|
|
49
|
+
|
|
50
|
+
## Integration with SPARC Workflow
|
|
51
|
+
|
|
52
|
+
This is **Phase 1** of the MyAIDev Method SPARC workflow:
|
|
53
|
+
- **Current Phase**: Architecture
|
|
54
|
+
- **Next Phase**: Implementation (`myai-dev-code`)
|
|
55
|
+
- **Outputs**: Architecture specifications for implementation
|
|
56
|
+
|
|
57
|
+
## MyAIDev Method Standards
|
|
58
|
+
|
|
59
|
+
All outputs follow MyAIDev Method conventions:
|
|
60
|
+
- Saved to `.myaidev-method/sparc/` directory
|
|
61
|
+
- Version controlled (git-friendly format)
|
|
62
|
+
- Includes visual diagrams (Mermaid)
|
|
63
|
+
- Documents all design decisions
|
|
64
|
+
"""
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
prompt = """
|
|
2
|
+
Implement features and write production-ready code using MyAIDev Method's systematic approach for: {{args}}
|
|
3
|
+
|
|
4
|
+
Invoke the MyAIDev Coder agent to implement features based on architecture specifications, following best practices and clean code principles.
|
|
5
|
+
|
|
6
|
+
## What It Does
|
|
7
|
+
|
|
8
|
+
The coder agent will:
|
|
9
|
+
1. Read architecture specifications
|
|
10
|
+
2. Plan implementation approach
|
|
11
|
+
3. Write clean, modular code
|
|
12
|
+
4. Follow SOLID principles
|
|
13
|
+
5. Implement error handling
|
|
14
|
+
6. Add security measures
|
|
15
|
+
7. Include inline documentation
|
|
16
|
+
8. Create basic tests
|
|
17
|
+
|
|
18
|
+
## Output
|
|
19
|
+
|
|
20
|
+
Creates implementation files in `.myaidev-method/sparc/code-output/`:
|
|
21
|
+
- Feature implementation code
|
|
22
|
+
- Utility functions and helpers
|
|
23
|
+
- Configuration files
|
|
24
|
+
- Basic unit tests
|
|
25
|
+
- Implementation notes
|
|
26
|
+
|
|
27
|
+
## Code Quality Standards
|
|
28
|
+
|
|
29
|
+
All code follows:
|
|
30
|
+
- **SOLID Principles**: Single responsibility, modularity
|
|
31
|
+
- **Clean Code**: DRY, KISS, YAGNI
|
|
32
|
+
- **Security**: Input validation, error handling, no secrets
|
|
33
|
+
- **Testing**: Testable code with >80% coverage target
|
|
34
|
+
- **Documentation**: Clear comments and inline docs
|
|
35
|
+
|
|
36
|
+
## Usage Patterns
|
|
37
|
+
|
|
38
|
+
You can specify:
|
|
39
|
+
- Task description (required) - Clear description of the implementation task
|
|
40
|
+
- --architecture <file> - Path to architecture specification (default: `.myaidev-method/sparc/architecture.md`)
|
|
41
|
+
- --test-driven - Use TDD approach (write tests first)
|
|
42
|
+
- --output-dir <path> - Custom output directory (default: `.myaidev-method/sparc/code-output/`)
|
|
43
|
+
|
|
44
|
+
## Examples
|
|
45
|
+
|
|
46
|
+
### Implement Authentication
|
|
47
|
+
"Implement JWT-based authentication with refresh tokens"
|
|
48
|
+
|
|
49
|
+
### Build API Endpoints
|
|
50
|
+
"Create REST API endpoints for user management"
|
|
51
|
+
|
|
52
|
+
### Refactor Existing Code
|
|
53
|
+
"Refactor payment processing to improve testability and error handling"
|
|
54
|
+
|
|
55
|
+
### Test-Driven Development
|
|
56
|
+
"Implement order checkout workflow --test-driven"
|
|
57
|
+
|
|
58
|
+
## Integration with SPARC Workflow
|
|
59
|
+
|
|
60
|
+
This is **Phase 2** of the MyAIDev Method SPARC workflow:
|
|
61
|
+
- **Previous Phase**: Architecture (`myai-dev-architect`)
|
|
62
|
+
- **Current Phase**: Implementation
|
|
63
|
+
- **Next Phase**: Testing (`myai-dev-test`)
|
|
64
|
+
- **Inputs**: Architecture specifications
|
|
65
|
+
- **Outputs**: Production-ready code
|
|
66
|
+
|
|
67
|
+
## MyAIDev Method Standards
|
|
68
|
+
|
|
69
|
+
All code follows MyAIDev Method conventions:
|
|
70
|
+
- Modular and maintainable
|
|
71
|
+
- Secure by design
|
|
72
|
+
- Well-documented
|
|
73
|
+
- Testable architecture
|
|
74
|
+
- Follows project patterns
|
|
75
|
+
"""
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
prompt = """
|
|
2
|
+
Generate comprehensive documentation using MyAIDev Method's systematic approach for: {{args}}
|
|
3
|
+
|
|
4
|
+
Invoke the MyAIDev Documenter agent to create API documentation, user guides, architecture docs, and technical specifications.
|
|
5
|
+
|
|
6
|
+
## What It Does
|
|
7
|
+
|
|
8
|
+
The documenter agent will:
|
|
9
|
+
1. Analyze code structure and interfaces
|
|
10
|
+
2. Extract API contracts and endpoints
|
|
11
|
+
3. Generate comprehensive documentation
|
|
12
|
+
4. Create usage examples and code samples
|
|
13
|
+
5. Document edge cases and error handling
|
|
14
|
+
6. Generate visual diagrams (architecture, data flow)
|
|
15
|
+
7. Create searchable API reference
|
|
16
|
+
8. Produce user-friendly guides
|
|
17
|
+
|
|
18
|
+
## Output
|
|
19
|
+
|
|
20
|
+
Creates documentation files in `.myaidev-method/sparc/documentation/`:
|
|
21
|
+
- API reference documentation
|
|
22
|
+
- User guides and tutorials
|
|
23
|
+
- Architecture documentation
|
|
24
|
+
- Code examples and snippets
|
|
25
|
+
- Mermaid diagrams
|
|
26
|
+
- OpenAPI/Swagger specs (if applicable)
|
|
27
|
+
|
|
28
|
+
## Documentation Standards
|
|
29
|
+
|
|
30
|
+
All documentation follows:
|
|
31
|
+
- **Clarity**: Simple language, clear examples, visual aids
|
|
32
|
+
- **Completeness**: All public APIs documented, edge cases covered
|
|
33
|
+
- **Accuracy**: Code examples tested, documentation synchronized with code
|
|
34
|
+
- **Accessibility**: Multiple formats, searchable, well-organized
|
|
35
|
+
- **Maintenance**: Version-controlled, update procedures documented
|
|
36
|
+
|
|
37
|
+
## Usage Patterns
|
|
38
|
+
|
|
39
|
+
You can specify:
|
|
40
|
+
- Task description (required) - Clear description of documentation requirements
|
|
41
|
+
- --type <type> - Documentation type: api, user-guide, architecture, technical (default: api)
|
|
42
|
+
- --format <format> - Output format: markdown, html, openapi, swagger (default: markdown)
|
|
43
|
+
- --output-dir <path> - Custom output directory (default: `.myaidev-method/sparc/documentation/`)
|
|
44
|
+
|
|
45
|
+
## Examples
|
|
46
|
+
|
|
47
|
+
### API Documentation
|
|
48
|
+
"Document REST API endpoints for user management"
|
|
49
|
+
|
|
50
|
+
### User Guide
|
|
51
|
+
"Create user guide for authentication system --type user-guide"
|
|
52
|
+
|
|
53
|
+
### Architecture Documentation
|
|
54
|
+
"Document system architecture and design decisions --type architecture"
|
|
55
|
+
|
|
56
|
+
### OpenAPI Specification
|
|
57
|
+
"Generate OpenAPI spec for payment API --format openapi"
|
|
58
|
+
|
|
59
|
+
## Integration with SPARC Workflow
|
|
60
|
+
|
|
61
|
+
This is **Phase 5** of the MyAIDev Method SPARC workflow:
|
|
62
|
+
- **Previous Phase**: Review (`myai-dev-review`)
|
|
63
|
+
- **Current Phase**: Documentation
|
|
64
|
+
- **Final Phase**: Complete
|
|
65
|
+
- **Inputs**: Reviewed and validated code
|
|
66
|
+
- **Outputs**: Comprehensive documentation suite
|
|
67
|
+
|
|
68
|
+
## MyAIDev Method Standards
|
|
69
|
+
|
|
70
|
+
All documentation follows MyAIDev Method conventions:
|
|
71
|
+
- Saved to `.myaidev-method/sparc/documentation/` directory
|
|
72
|
+
- Version controlled (Markdown format)
|
|
73
|
+
- Includes visual diagrams (Mermaid)
|
|
74
|
+
- Code examples tested and verified
|
|
75
|
+
- Multiple audience levels supported
|
|
76
|
+
"""
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
prompt = """
|
|
2
|
+
Perform comprehensive code review using MyAIDev Method's systematic approach for: {{args}}
|
|
3
|
+
|
|
4
|
+
Invoke the MyAIDev Reviewer agent to analyze code quality, security vulnerabilities, performance issues, and best practices compliance.
|
|
5
|
+
|
|
6
|
+
## What It Does
|
|
7
|
+
|
|
8
|
+
The reviewer agent will:
|
|
9
|
+
1. Analyze code quality and maintainability
|
|
10
|
+
2. Check for security vulnerabilities (OWASP Top 10)
|
|
11
|
+
3. Review performance and optimization opportunities
|
|
12
|
+
4. Validate best practices compliance
|
|
13
|
+
5. Identify code smells and anti-patterns
|
|
14
|
+
6. Assess technical debt
|
|
15
|
+
7. Provide actionable recommendations
|
|
16
|
+
8. Generate comprehensive review report
|
|
17
|
+
|
|
18
|
+
## Output
|
|
19
|
+
|
|
20
|
+
Creates `.myaidev-method/sparc/review-report.md` containing:
|
|
21
|
+
- Executive summary with quality scores
|
|
22
|
+
- Critical/High/Medium/Low priority issues
|
|
23
|
+
- Security analysis (OWASP Top 10 compliance)
|
|
24
|
+
- Performance metrics and bottlenecks
|
|
25
|
+
- Code quality assessment
|
|
26
|
+
- Technical debt evaluation
|
|
27
|
+
- Testing recommendations
|
|
28
|
+
- Actionable improvement plan
|
|
29
|
+
|
|
30
|
+
## Review Standards
|
|
31
|
+
|
|
32
|
+
All reviews cover:
|
|
33
|
+
- **Code Quality**: Complexity, readability, maintainability
|
|
34
|
+
- **Security**: OWASP Top 10, vulnerability patterns
|
|
35
|
+
- **Performance**: Algorithm complexity, resource management
|
|
36
|
+
- **Best Practices**: SOLID principles, framework standards
|
|
37
|
+
- **Technical Debt**: Assessment, prioritization, remediation
|
|
38
|
+
|
|
39
|
+
## Usage Patterns
|
|
40
|
+
|
|
41
|
+
You can specify:
|
|
42
|
+
- Task description (required) - Clear description of review scope
|
|
43
|
+
- --security - Focus on security analysis (OWASP Top 10)
|
|
44
|
+
- --performance - Focus on performance optimization
|
|
45
|
+
- --output-dir <path> - Custom output directory (default: `.myaidev-method/sparc/`)
|
|
46
|
+
|
|
47
|
+
## Examples
|
|
48
|
+
|
|
49
|
+
### General Code Review
|
|
50
|
+
"Review user authentication module for quality and security"
|
|
51
|
+
|
|
52
|
+
### Security-Focused Review
|
|
53
|
+
"Security audit of payment processing --security"
|
|
54
|
+
|
|
55
|
+
### Performance Review
|
|
56
|
+
"Review database layer for performance bottlenecks --performance"
|
|
57
|
+
|
|
58
|
+
### Pre-Production Review
|
|
59
|
+
"Final review before production deployment"
|
|
60
|
+
|
|
61
|
+
## Integration with SPARC Workflow
|
|
62
|
+
|
|
63
|
+
This is **Phase 4** of the MyAIDev Method SPARC workflow:
|
|
64
|
+
- **Previous Phase**: Testing (`myai-dev-test`)
|
|
65
|
+
- **Current Phase**: Review
|
|
66
|
+
- **Next Phase**: Documentation (`myai-dev-docs`)
|
|
67
|
+
- **Inputs**: Implemented and tested code
|
|
68
|
+
- **Outputs**: Comprehensive review report with recommendations
|
|
69
|
+
|
|
70
|
+
## MyAIDev Method Standards
|
|
71
|
+
|
|
72
|
+
All reviews follow MyAIDev Method conventions:
|
|
73
|
+
- Evidence-based analysis
|
|
74
|
+
- Actionable recommendations
|
|
75
|
+
- Priority-based issue tracking
|
|
76
|
+
- Security-first mindset
|
|
77
|
+
- Performance optimization focus
|
|
78
|
+
"""
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
prompt = """
|
|
2
|
+
Write and execute comprehensive tests using MyAIDev Method's systematic approach for: {{args}}
|
|
3
|
+
|
|
4
|
+
Invoke the MyAIDev Tester agent to create unit tests, integration tests, and validate code quality with coverage analysis.
|
|
5
|
+
|
|
6
|
+
## What It Does
|
|
7
|
+
|
|
8
|
+
The tester agent will:
|
|
9
|
+
1. Analyze code to be tested
|
|
10
|
+
2. Create comprehensive test suites
|
|
11
|
+
3. Write unit tests for components
|
|
12
|
+
4. Write integration tests for workflows
|
|
13
|
+
5. Generate test coverage reports
|
|
14
|
+
6. Identify untested edge cases
|
|
15
|
+
7. Validate quality gates
|
|
16
|
+
8. Provide improvement recommendations
|
|
17
|
+
|
|
18
|
+
## Output
|
|
19
|
+
|
|
20
|
+
Creates test files in `.myaidev-method/sparc/test-results/`:
|
|
21
|
+
- Unit test files
|
|
22
|
+
- Integration test files
|
|
23
|
+
- Test report with metrics
|
|
24
|
+
- Coverage report
|
|
25
|
+
- Quality gates validation
|
|
26
|
+
- Recommendations for improvement
|
|
27
|
+
|
|
28
|
+
## Testing Standards
|
|
29
|
+
|
|
30
|
+
All tests follow:
|
|
31
|
+
- **Coverage Requirements**: 80%+ for critical paths, 60%+ overall
|
|
32
|
+
- **Test Patterns**: AAA (Arrange, Act, Assert)
|
|
33
|
+
- **Edge Cases**: Boundary conditions, error scenarios
|
|
34
|
+
- **Integration**: End-to-end workflow validation
|
|
35
|
+
- **Quality Gates**: Pre-commit, pre-merge, pre-deployment
|
|
36
|
+
|
|
37
|
+
## Usage Patterns
|
|
38
|
+
|
|
39
|
+
You can specify:
|
|
40
|
+
- Task description (required) - Clear description of testing requirements
|
|
41
|
+
- --coverage - Generate coverage report
|
|
42
|
+
- --integration - Focus on integration tests
|
|
43
|
+
- --framework <name> - Specify testing framework (jest, mocha, pytest, etc.)
|
|
44
|
+
- --output-dir <path> - Custom output directory (default: `.myaidev-method/sparc/test-results/`)
|
|
45
|
+
|
|
46
|
+
## Examples
|
|
47
|
+
|
|
48
|
+
### Unit Testing
|
|
49
|
+
"Write unit tests for authentication module"
|
|
50
|
+
|
|
51
|
+
### Integration Testing
|
|
52
|
+
"Test complete checkout workflow --integration"
|
|
53
|
+
|
|
54
|
+
### Coverage Improvement
|
|
55
|
+
"Improve coverage for payment processing --coverage"
|
|
56
|
+
|
|
57
|
+
### Framework-Specific
|
|
58
|
+
"Create pytest tests for API endpoints --framework pytest"
|
|
59
|
+
|
|
60
|
+
## Integration with SPARC Workflow
|
|
61
|
+
|
|
62
|
+
This is **Phase 3** of the MyAIDev Method SPARC workflow:
|
|
63
|
+
- **Previous Phase**: Implementation (`myai-dev-code`)
|
|
64
|
+
- **Current Phase**: Testing
|
|
65
|
+
- **Next Phase**: Review (`myai-dev-review`)
|
|
66
|
+
- **Inputs**: Implemented code
|
|
67
|
+
- **Outputs**: Comprehensive test suite and coverage report
|
|
68
|
+
|
|
69
|
+
## MyAIDev Method Standards
|
|
70
|
+
|
|
71
|
+
All tests follow MyAIDev Method conventions:
|
|
72
|
+
- Comprehensive coverage (80%+ target)
|
|
73
|
+
- Clear test naming and organization
|
|
74
|
+
- Fast execution (<5s for unit tests)
|
|
75
|
+
- Isolated and independent tests
|
|
76
|
+
- Quality gate validation
|
|
77
|
+
"""
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
prompt = """
|
|
2
|
+
Publish markdown content to Docusaurus static site generator with automatic git workflow: {{args}}
|
|
3
|
+
|
|
4
|
+
Invoke the Docusaurus publishing agent to transform content and deploy via git.
|
|
5
|
+
|
|
6
|
+
## Task
|
|
7
|
+
Add markdown content to Docusaurus site and commit via git.
|
|
8
|
+
|
|
9
|
+
## Process
|
|
10
|
+
|
|
11
|
+
1. **Read the markdown file** from the path provided
|
|
12
|
+
2. **Determine content type** (docs, blog, or pages)
|
|
13
|
+
3. **Validate frontmatter** for Docusaurus compatibility
|
|
14
|
+
4. **Copy file to appropriate directory**:
|
|
15
|
+
- Docs: `docs/` or `versioned_docs/`
|
|
16
|
+
- Blog: `blog/`
|
|
17
|
+
- Pages: `src/pages/`
|
|
18
|
+
5. **Update navigation** (for docs) if needed
|
|
19
|
+
6. **Commit and push** via git workflow
|
|
20
|
+
|
|
21
|
+
## Parameters
|
|
22
|
+
|
|
23
|
+
When parsing {{args}}, look for:
|
|
24
|
+
- File path (required): Path to markdown file
|
|
25
|
+
- --type: docs (default), blog, or pages
|
|
26
|
+
- --project: Docusaurus project path (default: current directory)
|
|
27
|
+
- --branch: Git branch name (default: main)
|
|
28
|
+
- --no-push: Commit but don't push
|
|
29
|
+
- --dry-run: Validate without publishing
|
|
30
|
+
|
|
31
|
+
## Examples
|
|
32
|
+
|
|
33
|
+
Publish documentation:
|
|
34
|
+
```
|
|
35
|
+
myai-docusaurus-publish "getting-started.md"
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Publish blog post:
|
|
39
|
+
```
|
|
40
|
+
myai-docusaurus-publish "my-story.md" --type blog
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Custom project:
|
|
44
|
+
```
|
|
45
|
+
myai-docusaurus-publish "guide.md" --project ~/my-docs --branch staging
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Prerequisites
|
|
49
|
+
|
|
50
|
+
Requires Docusaurus project with:
|
|
51
|
+
- docusaurus.config.js
|
|
52
|
+
- Git repository initialized
|
|
53
|
+
- Appropriate directories (docs/, blog/, src/pages/)
|
|
54
|
+
|
|
55
|
+
## Git Workflow
|
|
56
|
+
|
|
57
|
+
1. Check for uncommitted changes
|
|
58
|
+
2. Create feature branch (optional)
|
|
59
|
+
3. Add the new file
|
|
60
|
+
4. Commit with descriptive message
|
|
61
|
+
5. Push to remote (unless --no-push)
|
|
62
|
+
6. Report git status and URLs
|
|
63
|
+
"""
|