moai-adk 0.25.4__py3-none-any.whl → 0.32.8__py3-none-any.whl
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.
Potentially problematic release.
This version of moai-adk might be problematic. Click here for more details.
- moai_adk/__init__.py +2 -5
- moai_adk/__main__.py +114 -82
- moai_adk/cli/__init__.py +6 -1
- moai_adk/cli/commands/__init__.py +1 -3
- moai_adk/cli/commands/analyze.py +5 -16
- moai_adk/cli/commands/doctor.py +6 -18
- moai_adk/cli/commands/init.py +56 -125
- moai_adk/cli/commands/language.py +14 -35
- moai_adk/cli/commands/status.py +9 -15
- moai_adk/cli/commands/update.py +1555 -190
- moai_adk/cli/prompts/init_prompts.py +112 -56
- moai_adk/cli/spec_status.py +263 -0
- moai_adk/cli/ui/__init__.py +44 -0
- moai_adk/cli/ui/progress.py +422 -0
- moai_adk/cli/ui/prompts.py +389 -0
- moai_adk/cli/ui/theme.py +129 -0
- moai_adk/cli/worktree/__init__.py +27 -0
- moai_adk/cli/worktree/__main__.py +31 -0
- moai_adk/cli/worktree/cli.py +672 -0
- moai_adk/cli/worktree/exceptions.py +89 -0
- moai_adk/cli/worktree/manager.py +490 -0
- moai_adk/cli/worktree/models.py +65 -0
- moai_adk/cli/worktree/registry.py +128 -0
- moai_adk/core/PHASE2_OPTIMIZATIONS.md +467 -0
- moai_adk/core/analysis/session_analyzer.py +17 -56
- moai_adk/core/claude_integration.py +26 -54
- moai_adk/core/command_helpers.py +10 -10
- moai_adk/core/comprehensive_monitoring_system.py +1183 -0
- moai_adk/core/config/auto_spec_config.py +5 -11
- moai_adk/core/config/migration.py +19 -9
- moai_adk/core/config/unified.py +436 -0
- moai_adk/core/context_manager.py +6 -12
- moai_adk/core/enterprise_features.py +1404 -0
- moai_adk/core/error_recovery_system.py +725 -112
- moai_adk/core/event_driven_hook_system.py +1371 -0
- moai_adk/core/git/__init__.py +8 -0
- moai_adk/core/git/branch_manager.py +3 -11
- moai_adk/core/git/checkpoint.py +1 -3
- moai_adk/core/git/conflict_detector.py +413 -0
- moai_adk/core/git/manager.py +91 -1
- moai_adk/core/hooks/post_tool_auto_spec_completion.py +56 -80
- moai_adk/core/input_validation_middleware.py +1006 -0
- moai_adk/core/integration/engine.py +6 -18
- moai_adk/core/integration/integration_tester.py +10 -9
- moai_adk/core/integration/utils.py +1 -1
- moai_adk/core/issue_creator.py +10 -28
- moai_adk/core/jit_context_loader.py +956 -0
- moai_adk/core/jit_enhanced_hook_manager.py +1987 -0
- moai_adk/core/language_config_resolver.py +485 -0
- moai_adk/core/language_validator.py +28 -41
- moai_adk/core/mcp/setup.py +15 -12
- moai_adk/core/merge/__init__.py +9 -0
- moai_adk/core/merge/analyzer.py +481 -0
- moai_adk/core/migration/alfred_to_moai_migrator.py +383 -0
- moai_adk/core/migration/backup_manager.py +78 -9
- moai_adk/core/migration/custom_element_scanner.py +358 -0
- moai_adk/core/migration/file_migrator.py +8 -17
- moai_adk/core/migration/interactive_checkbox_ui.py +488 -0
- moai_adk/core/migration/selective_restorer.py +470 -0
- moai_adk/core/migration/template_utils.py +74 -0
- moai_adk/core/migration/user_selection_ui.py +338 -0
- moai_adk/core/migration/version_detector.py +6 -10
- moai_adk/core/migration/version_migrator.py +3 -3
- moai_adk/core/performance/cache_system.py +8 -10
- moai_adk/core/phase_optimized_hook_scheduler.py +879 -0
- moai_adk/core/project/checker.py +2 -4
- moai_adk/core/project/detector.py +1 -3
- moai_adk/core/project/initializer.py +135 -23
- moai_adk/core/project/phase_executor.py +54 -81
- moai_adk/core/project/validator.py +6 -12
- moai_adk/core/quality/trust_checker.py +9 -27
- moai_adk/core/realtime_monitoring_dashboard.py +1724 -0
- moai_adk/core/robust_json_parser.py +611 -0
- moai_adk/core/rollback_manager.py +73 -148
- moai_adk/core/session_manager.py +10 -26
- moai_adk/core/skill_loading_system.py +579 -0
- moai_adk/core/spec/confidence_scoring.py +31 -100
- moai_adk/core/spec/ears_template_engine.py +351 -286
- moai_adk/core/spec/quality_validator.py +35 -69
- moai_adk/core/spec_status_manager.py +64 -74
- moai_adk/core/template/backup.py +45 -20
- moai_adk/core/template/config.py +112 -39
- moai_adk/core/template/merger.py +11 -19
- moai_adk/core/template/processor.py +253 -149
- moai_adk/core/template_engine.py +73 -40
- moai_adk/core/template_variable_synchronizer.py +417 -0
- moai_adk/core/unified_permission_manager.py +745 -0
- moai_adk/core/user_behavior_analytics.py +851 -0
- moai_adk/core/version_sync.py +429 -0
- moai_adk/foundation/__init__.py +56 -0
- moai_adk/foundation/backend.py +1027 -0
- moai_adk/foundation/database.py +1115 -0
- moai_adk/foundation/devops.py +1585 -0
- moai_adk/foundation/ears.py +431 -0
- moai_adk/foundation/frontend.py +870 -0
- moai_adk/foundation/git/commit_templates.py +4 -12
- moai_adk/foundation/git.py +376 -0
- moai_adk/foundation/langs.py +484 -0
- moai_adk/foundation/ml_ops.py +1162 -0
- moai_adk/foundation/testing.py +1524 -0
- moai_adk/foundation/trust/trust_principles.py +23 -72
- moai_adk/foundation/trust/validation_checklist.py +57 -162
- moai_adk/project/__init__.py +0 -0
- moai_adk/project/configuration.py +1084 -0
- moai_adk/project/documentation.py +566 -0
- moai_adk/project/schema.py +447 -0
- moai_adk/statusline/alfred_detector.py +1 -3
- moai_adk/statusline/config.py +13 -4
- moai_adk/statusline/enhanced_output_style_detector.py +23 -15
- moai_adk/statusline/main.py +51 -15
- moai_adk/statusline/renderer.py +104 -48
- moai_adk/statusline/update_checker.py +3 -9
- moai_adk/statusline/version_reader.py +140 -46
- moai_adk/templates/.claude/agents/moai/ai-nano-banana.md +549 -0
- moai_adk/templates/.claude/agents/moai/builder-agent.md +445 -0
- moai_adk/templates/.claude/agents/moai/builder-command.md +1132 -0
- moai_adk/templates/.claude/agents/moai/builder-skill.md +601 -0
- moai_adk/templates/.claude/agents/moai/expert-backend.md +831 -0
- moai_adk/templates/.claude/agents/moai/expert-database.md +774 -0
- moai_adk/templates/.claude/agents/moai/expert-debug.md +396 -0
- moai_adk/templates/.claude/agents/moai/expert-devops.md +711 -0
- moai_adk/templates/.claude/agents/moai/expert-frontend.md +666 -0
- moai_adk/templates/.claude/agents/moai/expert-security.md +474 -0
- moai_adk/templates/.claude/agents/moai/expert-uiux.md +1038 -0
- moai_adk/templates/.claude/agents/moai/manager-claude-code.md +429 -0
- moai_adk/templates/.claude/agents/moai/manager-docs.md +570 -0
- moai_adk/templates/.claude/agents/moai/manager-git.md +937 -0
- moai_adk/templates/.claude/agents/moai/manager-project.md +891 -0
- moai_adk/templates/.claude/agents/moai/manager-quality.md +598 -0
- moai_adk/templates/.claude/agents/moai/manager-spec.md +713 -0
- moai_adk/templates/.claude/agents/moai/manager-strategy.md +600 -0
- moai_adk/templates/.claude/agents/moai/manager-tdd.md +603 -0
- moai_adk/templates/.claude/agents/moai/mcp-context7.md +369 -0
- moai_adk/templates/.claude/agents/moai/mcp-figma.md +1567 -0
- moai_adk/templates/.claude/agents/moai/mcp-notion.md +749 -0
- moai_adk/templates/.claude/agents/moai/mcp-playwright.md +427 -0
- moai_adk/templates/.claude/agents/moai/mcp-sequential-thinking.md +994 -0
- moai_adk/templates/.claude/commands/moai/0-project.md +1143 -0
- moai_adk/templates/.claude/commands/moai/1-plan.md +1435 -0
- moai_adk/templates/.claude/commands/moai/2-run.md +883 -0
- moai_adk/templates/.claude/commands/moai/3-sync.md +993 -0
- moai_adk/templates/.claude/commands/moai/9-feedback.md +314 -0
- moai_adk/templates/.claude/hooks/__init__.py +8 -0
- moai_adk/templates/.claude/hooks/moai/__init__.py +8 -0
- moai_adk/templates/.claude/hooks/moai/lib/__init__.py +85 -0
- moai_adk/templates/.claude/hooks/moai/lib/checkpoint.py +244 -0
- moai_adk/templates/.claude/hooks/moai/lib/common.py +131 -0
- moai_adk/templates/.claude/hooks/moai/lib/config_manager.py +446 -0
- moai_adk/templates/.claude/hooks/moai/lib/config_validator.py +639 -0
- moai_adk/templates/.claude/hooks/moai/lib/example_config.json +104 -0
- moai_adk/templates/.claude/hooks/moai/lib/git_operations_manager.py +590 -0
- moai_adk/templates/.claude/hooks/moai/lib/language_validator.py +317 -0
- moai_adk/templates/.claude/hooks/moai/lib/models.py +102 -0
- moai_adk/templates/.claude/hooks/moai/lib/path_utils.py +28 -0
- moai_adk/templates/.claude/hooks/moai/lib/project.py +768 -0
- moai_adk/templates/.claude/hooks/moai/lib/test_hooks_improvements.py +443 -0
- moai_adk/templates/.claude/hooks/moai/lib/timeout.py +160 -0
- moai_adk/templates/.claude/hooks/moai/lib/unified_timeout_manager.py +530 -0
- moai_adk/templates/.claude/hooks/moai/session_end__auto_cleanup.py +862 -0
- moai_adk/templates/.claude/hooks/moai/session_start__show_project_info.py +921 -0
- moai_adk/templates/.claude/output-styles/moai/r2d2.md +380 -0
- moai_adk/templates/.claude/output-styles/moai/yoda.md +338 -0
- moai_adk/templates/.claude/settings.json +172 -0
- moai_adk/templates/.claude/skills/moai-docs-generation/SKILL.md +247 -0
- moai_adk/templates/.claude/skills/moai-docs-generation/modules/README.md +44 -0
- moai_adk/templates/.claude/skills/moai-docs-generation/modules/api-documentation.md +130 -0
- moai_adk/templates/.claude/skills/moai-docs-generation/modules/code-documentation.md +152 -0
- moai_adk/templates/.claude/skills/moai-docs-generation/modules/multi-format-output.md +178 -0
- moai_adk/templates/.claude/skills/moai-docs-generation/modules/user-guides.md +147 -0
- moai_adk/templates/.claude/skills/moai-domain-backend/SKILL.md +319 -0
- moai_adk/templates/.claude/skills/moai-domain-database/SKILL.md +320 -0
- moai_adk/templates/.claude/skills/moai-domain-database/modules/README.md +53 -0
- moai_adk/templates/.claude/skills/moai-domain-database/modules/mongodb.md +231 -0
- moai_adk/templates/.claude/skills/moai-domain-database/modules/postgresql.md +169 -0
- moai_adk/templates/.claude/skills/moai-domain-database/modules/redis.md +262 -0
- moai_adk/templates/.claude/skills/moai-domain-frontend/SKILL.md +496 -0
- moai_adk/templates/.claude/skills/moai-domain-uiux/SKILL.md +453 -0
- moai_adk/templates/.claude/skills/moai-domain-uiux/examples.md +560 -0
- moai_adk/templates/.claude/skills/moai-domain-uiux/modules/accessibility-wcag.md +260 -0
- moai_adk/templates/.claude/skills/moai-domain-uiux/modules/component-architecture.md +228 -0
- moai_adk/templates/.claude/skills/moai-domain-uiux/modules/design-system-tokens.md +405 -0
- moai_adk/templates/.claude/skills/moai-domain-uiux/modules/icon-libraries.md +401 -0
- moai_adk/templates/.claude/skills/moai-domain-uiux/modules/theming-system.md +373 -0
- moai_adk/templates/.claude/skills/moai-domain-uiux/reference.md +243 -0
- moai_adk/templates/.claude/skills/moai-formats-data/SKILL.md +491 -0
- moai_adk/templates/.claude/skills/moai-formats-data/modules/README.md +98 -0
- moai_adk/templates/.claude/skills/moai-formats-data/modules/SKILL-MODULARIZATION-TEMPLATE.md +278 -0
- moai_adk/templates/.claude/skills/moai-formats-data/modules/caching-performance.md +459 -0
- moai_adk/templates/.claude/skills/moai-formats-data/modules/data-validation.md +485 -0
- moai_adk/templates/.claude/skills/moai-formats-data/modules/json-optimization.md +374 -0
- moai_adk/templates/.claude/skills/moai-formats-data/modules/toon-encoding.md +308 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/SKILL.md +201 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/best-practices-checklist.md +616 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/claude-code-custom-slash-commands-official.md +729 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/claude-code-hooks-official.md +560 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/claude-code-iam-official.md +635 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/claude-code-memory-official.md +543 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/claude-code-settings-official.md +663 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/claude-code-skills-official.md +113 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/claude-code-sub-agents-official.md +238 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/complete-configuration-guide.md +175 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/skill-examples.md +1674 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/skill-formatting-guide.md +729 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/sub-agents/sub-agent-examples.md +1513 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/sub-agents/sub-agent-formatting-guide.md +1086 -0
- moai_adk/templates/.claude/skills/moai-foundation-claude/reference/sub-agents/sub-agent-integration-patterns.md +1100 -0
- moai_adk/templates/.claude/skills/moai-foundation-context/SKILL.md +438 -0
- moai_adk/templates/.claude/skills/moai-foundation-core/SKILL.md +515 -0
- moai_adk/templates/.claude/skills/moai-foundation-core/modules/README.md +296 -0
- moai_adk/templates/.claude/skills/moai-foundation-core/modules/agents-reference.md +346 -0
- moai_adk/templates/.claude/skills/moai-foundation-core/modules/commands-reference.md +432 -0
- moai_adk/templates/.claude/skills/moai-foundation-core/modules/delegation-patterns.md +757 -0
- moai_adk/templates/.claude/skills/moai-foundation-core/modules/execution-rules.md +687 -0
- moai_adk/templates/.claude/skills/moai-foundation-core/modules/modular-system.md +665 -0
- moai_adk/templates/.claude/skills/moai-foundation-core/modules/progressive-disclosure.md +649 -0
- moai_adk/templates/.claude/skills/moai-foundation-core/modules/spec-first-tdd.md +864 -0
- moai_adk/templates/.claude/skills/moai-foundation-core/modules/token-optimization.md +708 -0
- moai_adk/templates/.claude/skills/moai-foundation-core/modules/trust-5-framework.md +981 -0
- moai_adk/templates/.claude/skills/moai-foundation-quality/SKILL.md +362 -0
- moai_adk/templates/.claude/skills/moai-foundation-quality/examples.md +1232 -0
- moai_adk/templates/.claude/skills/moai-foundation-quality/modules/best-practices.md +261 -0
- moai_adk/templates/.claude/skills/moai-foundation-quality/modules/integration-patterns.md +194 -0
- moai_adk/templates/.claude/skills/moai-foundation-quality/modules/proactive-analysis.md +229 -0
- moai_adk/templates/.claude/skills/moai-foundation-quality/modules/trust5-validation.md +169 -0
- moai_adk/templates/.claude/skills/moai-foundation-quality/reference.md +1266 -0
- moai_adk/templates/.claude/skills/moai-foundation-quality/scripts/quality-gate.sh +668 -0
- moai_adk/templates/.claude/skills/moai-foundation-quality/templates/github-actions-quality.yml +481 -0
- moai_adk/templates/.claude/skills/moai-foundation-quality/templates/quality-config.yaml +519 -0
- moai_adk/templates/.claude/skills/moai-integration-mcp/SKILL.md +352 -0
- moai_adk/templates/.claude/skills/moai-integration-mcp/modules/README.md +52 -0
- moai_adk/templates/.claude/skills/moai-integration-mcp/modules/error-handling.md +334 -0
- moai_adk/templates/.claude/skills/moai-integration-mcp/modules/integration-patterns.md +310 -0
- moai_adk/templates/.claude/skills/moai-integration-mcp/modules/security-authentication.md +256 -0
- moai_adk/templates/.claude/skills/moai-integration-mcp/modules/server-architecture.md +253 -0
- moai_adk/templates/.claude/skills/moai-lang-unified/README.md +133 -0
- moai_adk/templates/.claude/skills/moai-lang-unified/SKILL.md +296 -0
- moai_adk/templates/.claude/skills/moai-lang-unified/examples.md +1269 -0
- moai_adk/templates/.claude/skills/moai-lang-unified/reference.md +331 -0
- moai_adk/templates/.claude/skills/moai-library-mermaid/SKILL.md +298 -0
- moai_adk/templates/.claude/skills/moai-library-mermaid/advanced-patterns.md +465 -0
- moai_adk/templates/.claude/skills/moai-library-mermaid/examples.md +270 -0
- moai_adk/templates/.claude/skills/moai-library-mermaid/optimization.md +440 -0
- moai_adk/templates/.claude/skills/moai-library-mermaid/reference.md +228 -0
- moai_adk/templates/.claude/skills/moai-library-nextra/SKILL.md +316 -0
- moai_adk/templates/.claude/skills/moai-library-nextra/advanced-patterns.md +336 -0
- moai_adk/templates/.claude/skills/moai-library-nextra/modules/advanced-deployment-patterns.md +182 -0
- moai_adk/templates/.claude/skills/moai-library-nextra/modules/advanced-patterns.md +17 -0
- moai_adk/templates/.claude/skills/moai-library-nextra/modules/configuration.md +57 -0
- moai_adk/templates/.claude/skills/moai-library-nextra/modules/content-architecture-optimization.md +162 -0
- moai_adk/templates/.claude/skills/moai-library-nextra/modules/deployment.md +52 -0
- moai_adk/templates/.claude/skills/moai-library-nextra/modules/framework-core-configuration.md +186 -0
- moai_adk/templates/.claude/skills/moai-library-nextra/modules/i18n-setup.md +55 -0
- moai_adk/templates/.claude/skills/moai-library-nextra/modules/mdx-components.md +52 -0
- moai_adk/templates/.claude/skills/moai-library-nextra/optimization.md +303 -0
- moai_adk/templates/.claude/skills/moai-library-shadcn/SKILL.md +370 -0
- moai_adk/templates/.claude/skills/moai-library-shadcn/examples.md +575 -0
- moai_adk/templates/.claude/skills/moai-library-shadcn/modules/advanced-patterns.md +394 -0
- moai_adk/templates/.claude/skills/moai-library-shadcn/modules/optimization.md +278 -0
- moai_adk/templates/.claude/skills/moai-library-shadcn/modules/shadcn-components.md +457 -0
- moai_adk/templates/.claude/skills/moai-library-shadcn/modules/shadcn-theming.md +373 -0
- moai_adk/templates/.claude/skills/moai-library-shadcn/reference.md +74 -0
- moai_adk/templates/.claude/skills/moai-platform-baas/README.md +186 -0
- moai_adk/templates/.claude/skills/moai-platform-baas/SKILL.md +290 -0
- moai_adk/templates/.claude/skills/moai-platform-baas/examples.md +1225 -0
- moai_adk/templates/.claude/skills/moai-platform-baas/reference.md +567 -0
- moai_adk/templates/.claude/skills/moai-platform-baas/scripts/provider-selector.py +323 -0
- moai_adk/templates/.claude/skills/moai-platform-baas/templates/stack-config.yaml +204 -0
- moai_adk/templates/.claude/skills/moai-workflow-jit-docs/SKILL.md +446 -0
- moai_adk/templates/.claude/skills/moai-workflow-jit-docs/advanced-patterns.md +379 -0
- moai_adk/templates/.claude/skills/moai-workflow-jit-docs/optimization.md +286 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/README.md +190 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/SKILL.md +387 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/__init__.py +520 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/complete_workflow_demo_fixed.py +574 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/examples/complete_project_setup.py +317 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/examples/complete_workflow_demo.py +663 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/examples/config-migration-example.json +190 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/examples/question-examples.json +135 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/examples/quick_start.py +196 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/modules/__init__.py +17 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/modules/advanced-patterns.md +158 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/modules/ask_user_integration.py +340 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/modules/batch_questions.py +713 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/modules/config_manager.py +538 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/modules/documentation_manager.py +1336 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/modules/language_initializer.py +730 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/modules/migration_manager.py +608 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/modules/template_optimizer.py +1005 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/schemas/config-schema.json +316 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/schemas/tab_schema.json +1362 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/templates/config-template.json +71 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/templates/doc-templates/product-template.md +44 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/templates/doc-templates/structure-template.md +48 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/templates/doc-templates/tech-template.md +71 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/templates/question-templates/config-manager-setup.json +109 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/templates/question-templates/language-initializer.json +228 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/templates/question-templates/menu-project-config.json +130 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/templates/question-templates/project-batch-questions.json +97 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/templates/question-templates/spec-workflow-setup.json +150 -0
- moai_adk/templates/.claude/skills/moai-workflow-project/test_integration_simple.py +436 -0
- moai_adk/templates/.claude/skills/moai-workflow-templates/SKILL.md +374 -0
- moai_adk/templates/.claude/skills/moai-workflow-templates/modules/code-templates.md +124 -0
- moai_adk/templates/.claude/skills/moai-workflow-templates/modules/feedback-templates.md +100 -0
- moai_adk/templates/.claude/skills/moai-workflow-templates/modules/template-optimizer.md +138 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/LICENSE.txt +202 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/SKILL.md +453 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/advanced-patterns.md +576 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/examples/ai-powered-testing.py +294 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/examples/console_logging.py +35 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/examples/element_discovery.py +40 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/examples/static_html_automation.py +34 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/modules/README.md +220 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/modules/ai-debugging.md +845 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/modules/automated-code-review.md +1416 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/modules/performance-optimization.md +1234 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/modules/smart-refactoring.md +1243 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/modules/tdd-context7.md +1260 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/optimization.md +505 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/reference/playwright-best-practices.md +57 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/scripts/with_server.py +218 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/templates/alfred-integration.md +376 -0
- moai_adk/templates/.claude/skills/moai-workflow-testing/workflows/enterprise-testing-workflow.py +571 -0
- moai_adk/templates/.claude/skills/moai-worktree/SKILL.md +410 -0
- moai_adk/templates/.claude/skills/moai-worktree/examples.md +606 -0
- moai_adk/templates/.claude/skills/moai-worktree/modules/integration-patterns.md +982 -0
- moai_adk/templates/.claude/skills/moai-worktree/modules/parallel-development.md +778 -0
- moai_adk/templates/.claude/skills/moai-worktree/modules/worktree-commands.md +646 -0
- moai_adk/templates/.claude/skills/moai-worktree/modules/worktree-management.md +782 -0
- moai_adk/templates/.claude/skills/moai-worktree/reference.md +357 -0
- moai_adk/templates/.git-hooks/pre-commit +103 -41
- moai_adk/templates/.git-hooks/pre-push +116 -21
- moai_adk/templates/.github/workflows/ci-universal.yml +513 -0
- moai_adk/templates/.github/workflows/security-secrets-check.yml +179 -0
- moai_adk/templates/.gitignore +184 -44
- moai_adk/templates/.mcp.json +7 -9
- moai_adk/templates/.moai/cache/personalization.json +10 -0
- moai_adk/templates/.moai/config/config.yaml +344 -0
- moai_adk/templates/.moai/config/presets/manual.yaml +28 -0
- moai_adk/templates/.moai/config/presets/personal.yaml +30 -0
- moai_adk/templates/.moai/config/presets/team.yaml +33 -0
- moai_adk/templates/.moai/config/questions/_schema.yaml +79 -0
- moai_adk/templates/.moai/config/questions/tab1-user.yaml +108 -0
- moai_adk/templates/.moai/config/questions/tab2-project.yaml +122 -0
- moai_adk/templates/.moai/config/questions/tab3-git.yaml +542 -0
- moai_adk/templates/.moai/config/questions/tab4-quality.yaml +167 -0
- moai_adk/templates/.moai/config/questions/tab5-system.yaml +152 -0
- moai_adk/templates/.moai/config/sections/git-strategy.yaml +40 -0
- moai_adk/templates/.moai/config/sections/language.yaml +11 -0
- moai_adk/templates/.moai/config/sections/project.yaml +13 -0
- moai_adk/templates/.moai/config/sections/quality.yaml +15 -0
- moai_adk/templates/.moai/config/sections/system.yaml +14 -0
- moai_adk/templates/.moai/config/sections/user.yaml +5 -0
- moai_adk/templates/.moai/config/statusline-config.yaml +86 -0
- moai_adk/templates/.moai/scripts/setup-glm.py +136 -0
- moai_adk/templates/CLAUDE.md +382 -501
- moai_adk/utils/__init__.py +24 -1
- moai_adk/utils/banner.py +7 -10
- moai_adk/utils/common.py +16 -30
- moai_adk/utils/link_validator.py +4 -12
- moai_adk/utils/safe_file_reader.py +2 -6
- moai_adk/utils/timeout.py +160 -0
- moai_adk/utils/toon_utils.py +256 -0
- moai_adk/version.py +22 -0
- moai_adk-0.32.8.dist-info/METADATA +2478 -0
- moai_adk-0.32.8.dist-info/RECORD +396 -0
- {moai_adk-0.25.4.dist-info → moai_adk-0.32.8.dist-info}/WHEEL +1 -1
- {moai_adk-0.25.4.dist-info → moai_adk-0.32.8.dist-info}/entry_points.txt +1 -0
- moai_adk/cli/commands/backup.py +0 -82
- moai_adk/cli/commands/improve_user_experience.py +0 -348
- moai_adk/cli/commands/migrate.py +0 -158
- moai_adk/cli/commands/validate_links.py +0 -118
- moai_adk/templates/.github/workflows/moai-gitflow.yml +0 -413
- moai_adk/templates/.github/workflows/moai-release-create.yml +0 -100
- moai_adk/templates/.github/workflows/moai-release-pipeline.yml +0 -188
- moai_adk/utils/user_experience.py +0 -531
- moai_adk-0.25.4.dist-info/METADATA +0 -2279
- moai_adk-0.25.4.dist-info/RECORD +0 -112
- {moai_adk-0.25.4.dist-info → moai_adk-0.32.8.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
# Reference: Mermaid Diagram Expert v5.0.0
|
|
2
|
+
|
|
3
|
+
## Official Documentation
|
|
4
|
+
|
|
5
|
+
### Core Resources
|
|
6
|
+
- [Mermaid Official Website](https://mermaid.js.org/) - Latest documentation
|
|
7
|
+
- [Mermaid Introduction](https://mermaid.js.org/intro/) - Getting started guide
|
|
8
|
+
- [Syntax Reference](https://mermaid.js.org/syntax/) - Complete syntax for all diagram types
|
|
9
|
+
- [Live Editor](https://mermaid.live/) - Interactive testing environment
|
|
10
|
+
- [GitHub Repository](https://github.com/mermaid-js/mermaid) - Source code and issues
|
|
11
|
+
|
|
12
|
+
### CLI Tools
|
|
13
|
+
- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli) - Official Node.js CLI tool
|
|
14
|
+
- [Mermaid CLI Docker](https://hub.docker.com/r/minlag/mermaid-cli) - Docker image
|
|
15
|
+
|
|
16
|
+
### Framework Integration
|
|
17
|
+
- [Nextra Mermaid Support](https://nextra.site/) - Documentation site integration
|
|
18
|
+
- [Remark Mermaid](https://github.com/remarkjs/remark-mermaid) - Markdown processor plugin
|
|
19
|
+
- [Gatsby Plugin](https://www.gatsbyjs.com/plugins/@ramonak/gatsby-plugin-mermaid/) - Gatsby integration
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Diagram Type Resources
|
|
24
|
+
|
|
25
|
+
### Flowchart / Graph
|
|
26
|
+
- [Flowchart Syntax](https://mermaid.js.org/syntax/flowchart.html)
|
|
27
|
+
- [Node Shapes Reference](https://mermaid.js.org/syntax/flowchart.html#node-shapes)
|
|
28
|
+
- [Styling & Colors](https://mermaid.js.org/syntax/flowchart.html#styling-and-classes)
|
|
29
|
+
|
|
30
|
+
### Sequence Diagram
|
|
31
|
+
- [Sequence Diagram Syntax](https://mermaid.js.org/syntax/sequenceDiagram.html)
|
|
32
|
+
- [Message Types](https://mermaid.js.org/syntax/sequenceDiagram.html#message-to-self)
|
|
33
|
+
- [Autonumbering](https://mermaid.js.org/syntax/sequenceDiagram.html#autonumber)
|
|
34
|
+
|
|
35
|
+
### Class Diagram
|
|
36
|
+
- [Class Diagram Syntax](https://mermaid.js.org/syntax/classDiagram.html)
|
|
37
|
+
- [UML Relationships](https://mermaid.js.org/syntax/classDiagram.html#relationship)
|
|
38
|
+
- [Visibility Modifiers](https://mermaid.js.org/syntax/classDiagram.html#class-member-visibility)
|
|
39
|
+
|
|
40
|
+
### State Diagram
|
|
41
|
+
- [State Diagram v2 Syntax](https://mermaid.js.org/syntax/stateDiagram.html)
|
|
42
|
+
- [Composite States](https://mermaid.js.org/syntax/stateDiagram.html#composite-states)
|
|
43
|
+
- [Parallel States](https://mermaid.js.org/syntax/stateDiagram.html#parallel-state)
|
|
44
|
+
|
|
45
|
+
### Entity Relationship (ER) Diagram
|
|
46
|
+
- [ER Diagram Syntax](https://mermaid.js.org/syntax/entityRelationshipDiagram.html)
|
|
47
|
+
- [Cardinality Notation](https://mermaid.js.org/syntax/entityRelationshipDiagram.html#cardinality)
|
|
48
|
+
- [Relationship Types](https://mermaid.js.org/syntax/entityRelationshipDiagram.html#relationships)
|
|
49
|
+
|
|
50
|
+
### Gantt Chart
|
|
51
|
+
- [Gantt Chart Syntax](https://mermaid.js.org/syntax/gantt.html)
|
|
52
|
+
- [Date Formats](https://mermaid.js.org/syntax/gantt.html#date-format)
|
|
53
|
+
- [Task Dependencies](https://mermaid.js.org/syntax/gantt.html#dependencies)
|
|
54
|
+
|
|
55
|
+
### Mindmap
|
|
56
|
+
- [Mindmap Syntax](https://mermaid.js.org/syntax/mindmap.html)
|
|
57
|
+
- [Icon Support](https://mermaid.js.org/syntax/mindmap.html#icons)
|
|
58
|
+
|
|
59
|
+
### Timeline
|
|
60
|
+
- [Timeline Syntax](https://mermaid.js.org/syntax/timeline.html)
|
|
61
|
+
- [Event Formatting](https://mermaid.js.org/syntax/timeline.html)
|
|
62
|
+
|
|
63
|
+
### Git Graph
|
|
64
|
+
- [Git Graph Syntax](https://mermaid.js.org/syntax/gitgraph.html)
|
|
65
|
+
- [Commit Types](https://mermaid.js.org/syntax/gitgraph.html#commit-type)
|
|
66
|
+
- [Branch Operations](https://mermaid.js.org/syntax/gitgraph.html#branch)
|
|
67
|
+
|
|
68
|
+
### C4 Diagram
|
|
69
|
+
- [C4 Model Syntax](https://mermaid.js.org/syntax/c4Diagram.html)
|
|
70
|
+
- [System Context](https://mermaid.js.org/syntax/c4Diagram.html#system-context-diagram)
|
|
71
|
+
- [Container Diagram](https://mermaid.js.org/syntax/c4Diagram.html#container-diagram)
|
|
72
|
+
|
|
73
|
+
### User Journey
|
|
74
|
+
- [User Journey Syntax](https://mermaid.js.org/syntax/userJourney.html)
|
|
75
|
+
- [Scoring System](https://mermaid.js.org/syntax/userJourney.html#section)
|
|
76
|
+
|
|
77
|
+
### Requirement Diagram
|
|
78
|
+
- [Requirement Diagram Syntax](https://mermaid.js.org/syntax/requirementDiagram.html)
|
|
79
|
+
- [Element Types](https://mermaid.js.org/syntax/requirementDiagram.html#elements)
|
|
80
|
+
|
|
81
|
+
### Pie Chart
|
|
82
|
+
- [Pie Chart Syntax](https://mermaid.js.org/syntax/pie.html)
|
|
83
|
+
- [Data Format](https://mermaid.js.org/syntax/pie.html#pie-example)
|
|
84
|
+
|
|
85
|
+
### Quadrant Chart
|
|
86
|
+
- [Quadrant Chart Syntax](https://mermaid.js.org/syntax/quadrantChart.html)
|
|
87
|
+
- [Axis Configuration](https://mermaid.js.org/syntax/quadrantChart.html#quadrant)
|
|
88
|
+
|
|
89
|
+
### XY Chart
|
|
90
|
+
- [XY Chart Syntax](https://mermaid.js.org/syntax/xychart.html)
|
|
91
|
+
- [Data Plotting](https://mermaid.js.org/syntax/xychart.html#scatter-plot)
|
|
92
|
+
|
|
93
|
+
### Block Diagram
|
|
94
|
+
- [Block Diagram Syntax](https://mermaid.js.org/syntax/block.html)
|
|
95
|
+
- [Nested Blocks](https://mermaid.js.org/syntax/block.html#nested-blocks)
|
|
96
|
+
|
|
97
|
+
### Sankey Diagram
|
|
98
|
+
- [Sankey Diagram Syntax](https://mermaid.js.org/syntax/sankey.html)
|
|
99
|
+
- [Flow Visualization](https://mermaid.js.org/syntax/sankey.html)
|
|
100
|
+
|
|
101
|
+
### Kanban Board
|
|
102
|
+
- [Kanban Syntax](https://mermaid.js.org/syntax/kanban.html)
|
|
103
|
+
- [Task Management](https://mermaid.js.org/syntax/kanban.html)
|
|
104
|
+
|
|
105
|
+
### Packet Diagram
|
|
106
|
+
- [Packet Diagram Syntax](https://mermaid.js.org/syntax/packet.html)
|
|
107
|
+
- [Protocol Structures](https://mermaid.js.org/syntax/packet.html)
|
|
108
|
+
|
|
109
|
+
### Radar Chart
|
|
110
|
+
- [Radar Chart Syntax](https://mermaid.js.org/syntax/radar.html)
|
|
111
|
+
- [Multi-dimensional Data](https://mermaid.js.org/syntax/radar.html)
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Configuration & Customization
|
|
116
|
+
|
|
117
|
+
### Mermaid Initialize Options
|
|
118
|
+
- [Theme Configuration](https://mermaid.js.org/config/configuration.html#theming)
|
|
119
|
+
- [Theme Variables](https://mermaid.js.org/config/theming.html)
|
|
120
|
+
- [Diagram-Specific Config](https://mermaid.js.org/config/configuration.html#diagram-configurations)
|
|
121
|
+
- [Accessibility Options](https://mermaid.js.org/config/accessibility.html)
|
|
122
|
+
|
|
123
|
+
### Styling
|
|
124
|
+
- [CSS Classes](https://mermaid.js.org/syntax/flowchart.html#styling-and-classes)
|
|
125
|
+
- [Color Themes](https://mermaid.js.org/config/theming.html)
|
|
126
|
+
- [SVG Classes](https://mermaid.js.org/syntax/flowchart.html#styling-with-css-classes)
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Troubleshooting
|
|
131
|
+
|
|
132
|
+
### Common Issues
|
|
133
|
+
|
|
134
|
+
Rendering Issues
|
|
135
|
+
- [Mermaid Rendering Troubleshooting](https://mermaid.js.org/ecosystem/integrations.html#troubleshooting)
|
|
136
|
+
- [Security Level Configuration](https://mermaid.js.org/config/configuration.html#security-level)
|
|
137
|
+
|
|
138
|
+
Performance
|
|
139
|
+
- [Large Diagram Optimization](https://mermaid.js.org/config/configuration.html#performance)
|
|
140
|
+
- [Lazy Loading](https://mermaid.js.org/config/configuration.html#lazy-load-example)
|
|
141
|
+
|
|
142
|
+
Browser Compatibility
|
|
143
|
+
- [Supported Browsers](https://mermaid.js.org/intro/index.html#browser-support)
|
|
144
|
+
- [IE11 Polyfills](https://mermaid.js.org/ecosystem/integrations.html)
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Python Integration
|
|
149
|
+
|
|
150
|
+
### PyPI Packages
|
|
151
|
+
- [mermaid-py](https://pypi.org/project/mermaid-py/) - Python wrapper
|
|
152
|
+
- [pypyrus](https://pypi.org/project/pypyrus/) - Diagram generation library
|
|
153
|
+
- [diagrams](https://diagrams.mingrammer.com/) - AWS/infrastructure diagrams
|
|
154
|
+
|
|
155
|
+
### Browser Automation
|
|
156
|
+
- [Playwright Documentation](https://playwright.dev/) - Cross-browser automation
|
|
157
|
+
- [Playwright Python](https://playwright.dev/python/) - Python bindings
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
## Tools & Services
|
|
162
|
+
|
|
163
|
+
### Online Tools
|
|
164
|
+
- [Mermaid Live Editor](https://mermaid.live) - Official editor
|
|
165
|
+
- [Mermaid Editor Pro](https://mermaid.ink/) - Enhanced editor
|
|
166
|
+
|
|
167
|
+
### VS Code Extensions
|
|
168
|
+
- [Mermaid Markdown Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=bpruitt-goddard.mermaid-markdown-syntax-highlighting)
|
|
169
|
+
- [Markdown Preview Mermaid](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid)
|
|
170
|
+
- [Mermaid Chart](https://marketplace.visualstudio.com/items?itemName=mermaid-js.mermaid-chart)
|
|
171
|
+
|
|
172
|
+
### GitHub Integration
|
|
173
|
+
- [GitHub Mermaid Support](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams) - Native support in markdown
|
|
174
|
+
|
|
175
|
+
### CI/CD
|
|
176
|
+
- [GitHub Actions Mermaid](https://github.com/marketplace/actions/mermaid-cli-action) - Action for diagram generation
|
|
177
|
+
- [GitLab Mermaid Support](https://docs.gitlab.com/ee/user/markdown.html#diagrams) - Native support
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## Best Practices
|
|
182
|
+
|
|
183
|
+
### Design Principles
|
|
184
|
+
- Clarity: Keep diagrams simple and focused
|
|
185
|
+
- Hierarchy: Use subgraphs to organize complex flows
|
|
186
|
+
- Consistency: Use same styling and notation throughout
|
|
187
|
+
- Documentation: Add notes and comments for clarity
|
|
188
|
+
|
|
189
|
+
### Performance Tips
|
|
190
|
+
1. Limit diagram complexity (max 100 nodes for flowcharts)
|
|
191
|
+
2. Use lazy loading for web applications
|
|
192
|
+
3. Cache rendered diagrams when possible
|
|
193
|
+
4. Validate syntax before rendering in production
|
|
194
|
+
|
|
195
|
+
### Accessibility
|
|
196
|
+
1. Add descriptive text and labels
|
|
197
|
+
2. Use high contrast colors
|
|
198
|
+
3. Provide alternative descriptions
|
|
199
|
+
4. Test with screen readers
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
## Version History
|
|
204
|
+
|
|
205
|
+
### v5.0.0 (Current)
|
|
206
|
+
- Added Python CLI tool (mermaid-to-svg-png.py)
|
|
207
|
+
- Support for all 21 diagram types
|
|
208
|
+
- Batch processing and automation
|
|
209
|
+
- GitHub Actions integration examples
|
|
210
|
+
- Comprehensive validation and error handling
|
|
211
|
+
|
|
212
|
+
### v4.0.0
|
|
213
|
+
- Foundation of Mermaid diagram support
|
|
214
|
+
- Nextra integration
|
|
215
|
+
- Auto-generation from source code
|
|
216
|
+
|
|
217
|
+
---
|
|
218
|
+
|
|
219
|
+
## Support & Community
|
|
220
|
+
|
|
221
|
+
- GitHub Issues: [mermaid-js/mermaid/issues](https://github.com/mermaid-js/mermaid/issues)
|
|
222
|
+
- Discussions: [mermaid-js/mermaid/discussions](https://github.com/mermaid-js/mermaid/discussions)
|
|
223
|
+
- Community Chat: [Mermaid Discord](https://discord.gg/mermaid)
|
|
224
|
+
- Stack Overflow: [mermaid tag](https://stackoverflow.com/questions/tagged/mermaid)
|
|
225
|
+
|
|
226
|
+
---
|
|
227
|
+
|
|
228
|
+
Last Updated: 2025-11-20
|
|
@@ -0,0 +1,316 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: moai-library-nextra
|
|
3
|
+
description: Enterprise Nextra documentation framework with Next.js
|
|
4
|
+
version: 2.0.0
|
|
5
|
+
modularized: true
|
|
6
|
+
aliases:
|
|
7
|
+
- moai-library-nextra
|
|
8
|
+
category: library
|
|
9
|
+
## Quick Reference (30 seconds)
|
|
10
|
+
|
|
11
|
+
Purpose: Build professional documentation sites with Nextra + Next.js.
|
|
12
|
+
|
|
13
|
+
Nextra Advantages:
|
|
14
|
+
|
|
15
|
+
- Zero config MDX (Markdown + JSX seamlessly)
|
|
16
|
+
- File-system routing (automatic routes)
|
|
17
|
+
- Performance optimized (code splitting, prefetching)
|
|
18
|
+
- Theme system (pluggable, customizable)
|
|
19
|
+
- i18n built-in (internationalization)
|
|
20
|
+
|
|
21
|
+
Core Files:
|
|
22
|
+
|
|
23
|
+
- `pages/` - Documentation pages (MDX)
|
|
24
|
+
- `theme.config.tsx` - Site configuration
|
|
25
|
+
- `_meta.js` - Navigation structure
|
|
26
|
+
|
|
27
|
+
## Implementation Guide (5 minutes)
|
|
28
|
+
|
|
29
|
+
### Features
|
|
30
|
+
|
|
31
|
+
- Nextra documentation framework architecture patterns
|
|
32
|
+
- Next.js 15 integration with optimal configuration
|
|
33
|
+
- Theme customization and component overrides
|
|
34
|
+
- Advanced search with FlexSearch integration
|
|
35
|
+
- Internationalization (i18n) support
|
|
36
|
+
- MDX-powered content with React components
|
|
37
|
+
|
|
38
|
+
### When to Use
|
|
39
|
+
|
|
40
|
+
- Building documentation sites with modern React features
|
|
41
|
+
- Creating knowledge bases with advanced search capabilities
|
|
42
|
+
- Developing multi-language documentation portals
|
|
43
|
+
- Implementing custom documentation themes
|
|
44
|
+
- Integrating interactive examples in technical docs
|
|
45
|
+
|
|
46
|
+
### Core Patterns
|
|
47
|
+
|
|
48
|
+
Pattern 1: Nextra Project Setup
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
# Initialize Nextra docs site
|
|
52
|
+
npx create-nextra-app@latest my-docs --template docs
|
|
53
|
+
|
|
54
|
+
# Project structure
|
|
55
|
+
pages/
|
|
56
|
+
_app.tsx (custom App component)
|
|
57
|
+
index.mdx (home page)
|
|
58
|
+
docs/
|
|
59
|
+
guide.mdx
|
|
60
|
+
api.mdx
|
|
61
|
+
_meta.json (navigation config)
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Pattern 2: Custom Theme Configuration
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
// theme.config.tsx
|
|
68
|
+
export default {
|
|
69
|
+
logo: <span>My Documentation</span>,
|
|
70
|
+
project: { link: "https://github.com/user/repo" },
|
|
71
|
+
docsRepositoryBase: "https://github.com/user/repo/tree/main",
|
|
72
|
+
useNextSeoProps: () => ({
|
|
73
|
+
titleTemplate: "%s – My Docs",
|
|
74
|
+
}),
|
|
75
|
+
};
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Pattern 3: MDX with React Components
|
|
79
|
+
|
|
80
|
+
```mdx
|
|
81
|
+
import { Callout } from "nextra/components";
|
|
82
|
+
|
|
83
|
+
# API Reference
|
|
84
|
+
|
|
85
|
+
<Callout type="info">This API requires authentication.</Callout>
|
|
86
|
+
|
|
87
|
+
<CustomCodeBlock language="typescript">// Your code here</CustomCodeBlock>
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Core Patterns (5-10 minutes)
|
|
91
|
+
|
|
92
|
+
### Pattern 1: Project Structure
|
|
93
|
+
|
|
94
|
+
Key Concept: Organize documentation files logically
|
|
95
|
+
|
|
96
|
+
Recommended Structure:
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
docs/
|
|
100
|
+
pages/
|
|
101
|
+
index.mdx # Homepage
|
|
102
|
+
getting-started/
|
|
103
|
+
_meta.js # Section config
|
|
104
|
+
index.mdx
|
|
105
|
+
installation.mdx
|
|
106
|
+
guides/
|
|
107
|
+
_meta.js
|
|
108
|
+
basics.mdx
|
|
109
|
+
advanced.mdx
|
|
110
|
+
api/
|
|
111
|
+
_meta.js
|
|
112
|
+
reference.mdx
|
|
113
|
+
public/ # Static assets
|
|
114
|
+
theme.config.tsx # Main config
|
|
115
|
+
next.config.js # Next.js config
|
|
116
|
+
package.json
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Pattern 2: Theme Configuration
|
|
120
|
+
|
|
121
|
+
Key Concept: Customize site appearance and behavior
|
|
122
|
+
|
|
123
|
+
Essential Config:
|
|
124
|
+
|
|
125
|
+
```typescript
|
|
126
|
+
const config: DocsThemeConfig = {
|
|
127
|
+
// Branding
|
|
128
|
+
logo: <span>My Docs</span>,
|
|
129
|
+
logoLink: "/",
|
|
130
|
+
|
|
131
|
+
// Navigation
|
|
132
|
+
project: { link: "https://github.com/..." },
|
|
133
|
+
docsRepositoryBase: "https://github.com/.../tree/main",
|
|
134
|
+
|
|
135
|
+
// Sidebar
|
|
136
|
+
sidebar: {
|
|
137
|
+
defaultMenuCollapseLevel: 1,
|
|
138
|
+
toggleButton: true,
|
|
139
|
+
},
|
|
140
|
+
|
|
141
|
+
// Table of contents
|
|
142
|
+
toc: { backToTop: true },
|
|
143
|
+
|
|
144
|
+
// Footer
|
|
145
|
+
footer: { text: "Built with Nextra" },
|
|
146
|
+
};
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### Pattern 3: Navigation Structure (\_meta.js)
|
|
150
|
+
|
|
151
|
+
Key Concept: Control sidebar menu and page ordering
|
|
152
|
+
|
|
153
|
+
Example:
|
|
154
|
+
|
|
155
|
+
```javascript
|
|
156
|
+
// pages/guides/_meta.js
|
|
157
|
+
export default {
|
|
158
|
+
index: "Overview",
|
|
159
|
+
"getting-started": "Getting Started",
|
|
160
|
+
basics: "Basic Concepts",
|
|
161
|
+
advanced: "Advanced Topics",
|
|
162
|
+
"---": "", // Separator
|
|
163
|
+
faq: "FAQ",
|
|
164
|
+
};
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Pattern 4: MDX Content & JSX Integration
|
|
168
|
+
|
|
169
|
+
Key Concept: Mix Markdown with React components
|
|
170
|
+
|
|
171
|
+
Example:
|
|
172
|
+
|
|
173
|
+
```mdx
|
|
174
|
+
# My Documentation
|
|
175
|
+
|
|
176
|
+
<div className="bg-blue-100 p-4">
|
|
177
|
+
<h3>Important Note</h3>
|
|
178
|
+
<p>You can embed React components directly!</p>
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
## Code Examples
|
|
182
|
+
|
|
183
|
+
export const MyComponent = () => (
|
|
184
|
+
<button onClick={() => alert("Clicked!")}>Click me</button>
|
|
185
|
+
);
|
|
186
|
+
|
|
187
|
+
<MyComponent />
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### Pattern 5: Search & SEO Optimization
|
|
191
|
+
|
|
192
|
+
Key Concept: Make documentation discoverable
|
|
193
|
+
|
|
194
|
+
Config:
|
|
195
|
+
|
|
196
|
+
```typescript
|
|
197
|
+
// theme.config.tsx
|
|
198
|
+
const config: DocsThemeConfig = {
|
|
199
|
+
// Enable search
|
|
200
|
+
search: {
|
|
201
|
+
placeholder: "Search docs...",
|
|
202
|
+
},
|
|
203
|
+
|
|
204
|
+
// SEO metadata
|
|
205
|
+
head: (
|
|
206
|
+
<>
|
|
207
|
+
<meta name="og:title" content="My Documentation" />
|
|
208
|
+
<meta name="og:description" content="Complete guide" />
|
|
209
|
+
<meta name="og:image" content="/og-image.png" />
|
|
210
|
+
</>
|
|
211
|
+
),
|
|
212
|
+
|
|
213
|
+
// Analytics
|
|
214
|
+
useNextSeoProps() {
|
|
215
|
+
return {
|
|
216
|
+
titleTemplate: "%s - My Docs",
|
|
217
|
+
};
|
|
218
|
+
},
|
|
219
|
+
};
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
---
|
|
223
|
+
|
|
224
|
+
## Advanced Documentation
|
|
225
|
+
|
|
226
|
+
This Skill uses Progressive Disclosure. For detailed patterns:
|
|
227
|
+
|
|
228
|
+
- [modules/configuration.md](modules/configuration.md) - Complete theme.config reference
|
|
229
|
+
- [modules/mdx-components.md](modules/mdx-components.md) - MDX component library
|
|
230
|
+
- [modules/i18n-setup.md](modules/i18n-setup.md) - Internationalization guide
|
|
231
|
+
- [modules/deployment.md](modules/deployment.md) - Hosting & deployment
|
|
232
|
+
|
|
233
|
+
---
|
|
234
|
+
|
|
235
|
+
## Theme Options
|
|
236
|
+
|
|
237
|
+
Built-in Themes:
|
|
238
|
+
|
|
239
|
+
- nextra-theme-docs (recommended for documentation)
|
|
240
|
+
- nextra-theme-blog (for blogs)
|
|
241
|
+
|
|
242
|
+
Customization:
|
|
243
|
+
|
|
244
|
+
- CSS variables for colors
|
|
245
|
+
- Custom sidebar components
|
|
246
|
+
- Footer customization
|
|
247
|
+
- Navigation layout
|
|
248
|
+
|
|
249
|
+
---
|
|
250
|
+
|
|
251
|
+
## Deployment
|
|
252
|
+
|
|
253
|
+
Popular Platforms:
|
|
254
|
+
|
|
255
|
+
- Vercel (zero-config, recommended)
|
|
256
|
+
- GitHub Pages (free, self-hosted)
|
|
257
|
+
- Netlify (flexible, CI/CD)
|
|
258
|
+
- Custom servers (full control)
|
|
259
|
+
|
|
260
|
+
Vercel Deployment:
|
|
261
|
+
|
|
262
|
+
```bash
|
|
263
|
+
npm install -g vercel
|
|
264
|
+
vercel
|
|
265
|
+
# Select project and deploy
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
---
|
|
269
|
+
|
|
270
|
+
## Integration with Other Skills
|
|
271
|
+
|
|
272
|
+
Complementary Skills:
|
|
273
|
+
|
|
274
|
+
- Skill("moai-docs-generation") - Auto-generate docs from code
|
|
275
|
+
- Skill("moai-workflow-docs") - Validate documentation quality
|
|
276
|
+
- Skill("moai-cc-claude-md") - Markdown formatting
|
|
277
|
+
|
|
278
|
+
---
|
|
279
|
+
|
|
280
|
+
## Version History
|
|
281
|
+
|
|
282
|
+
1.0.1 (2025-11-23)
|
|
283
|
+
|
|
284
|
+
- Refactored with Progressive Disclosure
|
|
285
|
+
- Configuration patterns highlighted
|
|
286
|
+
- MDX integration guide
|
|
287
|
+
|
|
288
|
+
1.0.0 (2025-11-12)
|
|
289
|
+
|
|
290
|
+
- Nextra architecture guide
|
|
291
|
+
- Theme configuration
|
|
292
|
+
- i18n support
|
|
293
|
+
|
|
294
|
+
---
|
|
295
|
+
|
|
296
|
+
Maintained by: alfred
|
|
297
|
+
Domain: Documentation Architecture
|
|
298
|
+
Generated with: MoAI-ADK Skill Factory
|
|
299
|
+
|
|
300
|
+
---
|
|
301
|
+
|
|
302
|
+
## Works Well With
|
|
303
|
+
|
|
304
|
+
Agents:
|
|
305
|
+
- workflow-docs - Documentation generation
|
|
306
|
+
- code-frontend - Nextra implementation
|
|
307
|
+
- workflow-spec - Architecture documentation
|
|
308
|
+
|
|
309
|
+
Skills:
|
|
310
|
+
- moai-docs-generation - Content generation
|
|
311
|
+
- moai-workflow-docs - Documentation validation
|
|
312
|
+
- moai-library-mermaid - Diagram integration
|
|
313
|
+
|
|
314
|
+
Commands:
|
|
315
|
+
- `/moai:3-sync` - Documentation deployment
|
|
316
|
+
- `/moai:0-project` - Nextra project initialization
|