moai-adk 0.32.8__py3-none-any.whl → 0.41.0__py3-none-any.whl

moai_adk/templates/.claude/skills/moai-docs-generation/modules/user-guides.md

@@ -1,147 +1,207 @@
-# User Guide Generation
+# User Guide Creation Patterns
 
 ## Overview
-Automated creation of comprehensive user guides, tutorials, getting started documentation, and cookbooks with AI-powered content generation.
 
-## Quick Implementation
+Create effective user guides, tutorials, and getting started documentation following best practices and established documentation standards.
 
-```python
-class UserGuideGenerator:
- def __init__(self, ai_client=None):
- self.ai_client = ai_client
+## Getting Started Guide Structure
 
- def generate_getting_started_guide(self, project_info: Dict) -> str:
- """Generate comprehensive getting started guide."""
+### Essential Sections
 
- guide_structure = [
- "# Getting Started",
- "",
- "## Prerequisites",
- self.generate_prerequisites_section(project_info),
- "",
- "## Installation",
- self.generate_installation_section(project_info),
- "",
- "## Quick Start",
- self.generate_quick_start_section(project_info),
- "",
- "## Basic Usage",
- self.generate_basic_usage_section(project_info),
- "",
- "## Next Steps",
- self.generate_next_steps_section(project_info)
- ]
+Prerequisites:
+- System requirements (OS, runtime versions)
+- Required tools and dependencies
+- Account or access requirements
+- Knowledge prerequisites
 
- return "\n".join(guide_structure)
-
- def generate_tutorial_series(self, features: List[Dict]) -> List[str]:
- """Generate a series of tutorials for different features."""
- tutorials = []
-
- for feature in features:
- tutorial = self.generate_feature_tutorial(feature)
- tutorials.append(tutorial)
-
- return tutorials
-
- def generate_feature_tutorial(self, feature: Dict) -> str:
- """Generate a single tutorial for a specific feature."""
-
- if self.ai_client:
- prompt = f"""
- Create a step-by-step tutorial for this feature:
-
- Feature Name: {feature['name']}
- Description: {feature['description']}
- Key Functions: {', '.join(feature.get('functions', []))}
- Example Usage: {feature.get('example', '')}
-
- Please include:
- 1. Clear introduction explaining what the feature does
- 2. Prerequisites and setup requirements
- 3. Step-by-step implementation guide
- 4. Complete code example
- 5. Common use cases and variations
- 6. Troubleshooting tips
- 7. Related features and next steps
-
- Format as a comprehensive tutorial with clear sections and code blocks.
- """
-
- response = self.ai_client.generate_content(prompt)
- return response["content"]
-
- else:
- return self.generate_basic_tutorial(feature)
-
- def generate_cookbook(self, use_cases: List[Dict]) -> str:
- """Generate a cookbook of common patterns and solutions."""
-
- cookbook_content = ["# Cookbook", "", "## Common Patterns and Solutions"]
-
- for use_case in use_cases:
- recipe = self.generate_recipe(use_case)
- cookbook_content.extend(["", recipe])
-
- return "\n".join(cookbook_content)
-
- def generate_recipe(self, use_case: Dict) -> str:
- """Generate a single recipe for the cookbook."""
-
- return f"""
-### {use_case['title']}
-
-Problem: {use_case['problem']}
-
-Solution: {use_case['solution']}
-
-Code Example:
-```python
-{use_case.get('example_code', '# Example implementation')}
-```
-
-Explanation: {use_case.get('explanation', 'Detailed explanation of the solution')}
-
-Variations: {use_case.get('variations', 'Common variations and adaptations')}
-
-Related Patterns: {', '.join(use_case.get('related_patterns', []))}
- """
-```
-
-## Guide Types
-
-### 1. Getting Started Guides
-- Prerequisites and requirements
-- Installation and setup
-- Quick start examples
-- Basic usage patterns
-- Next steps and resources
-
-### 2. Feature Tutorials
-- Step-by-step implementation
-- Complete working examples
-- Common use cases
-- Troubleshooting tips
-- Advanced variations
-
-### 3. Cookbooks
-- Problem-solution format
-- Code-first examples
-- Common patterns
-- Best practices
-- Performance tips
+Installation:
+- Package manager commands (npm, pip, etc.)
+- Configuration file setup
+- Environment variable configuration
+- Verification steps to confirm success
 
-## Content Generation Features
-- AI-powered tutorial creation
-- Structured content templates
-- Code example generation
-- Progressive difficulty scaling
-- Cross-references and links
-- Troubleshooting sections
+Quick Start:
+- Minimal working example
+- Expected output description
+- Common first-time issues and solutions
 
-## Integration Points
-- Project documentation systems
-- Developer onboarding workflows
-- Knowledge base platforms
-- Customer support systems
-- Educational platforms
+Basic Usage:
+- Core concepts explanation
+- Essential API or CLI commands
+- Simple workflow demonstration
+
+Next Steps:
+- Links to detailed tutorials
+- Reference documentation pointers
+- Community resources
+
+### Writing Effective Instructions
+
+Use imperative mood for actions: "Run the command" not "You should run"
+
+Break complex tasks into numbered steps:
+1. One action per step
+2. Include expected results
+3. Add troubleshooting for likely failures
+
+Provide copy-paste ready commands:
+- Use consistent command prefixes
+- Include expected output where helpful
+- Note platform-specific variations
+
+## Tutorial Structure
+
+### Tutorial Components
+
+Introduction:
+- What the reader will learn
+- Why this topic matters
+- Estimated completion time
+
+Prerequisites:
+- What should be completed first
+- Required background knowledge
+- Setup verification
+
+Step-by-Step Instructions:
+- Logical progression of steps
+- Each step builds on previous
+- Clear success indicators
+
+Complete Example:
+- Full working code at the end
+- Runnable without modifications
+- Includes all imports and setup
+
+Exercises:
+- Practice problems to reinforce learning
+- Variations to explore
+- Challenges for advanced readers
+
+### Tutorial Types
+
+Conceptual Tutorials:
+- Explain how things work
+- Use diagrams and analogies
+- Build mental models
+
+Task-Based Tutorials:
+- Focus on accomplishing specific goals
+- Step-by-step with clear outcomes
+- Practical and actionable
+
+Reference Tutorials:
+- Comprehensive feature coverage
+- Organized for lookup
+- Include all options and variations
+
+## Cookbook and Recipe Format
+
+### Recipe Structure
+
+Problem Statement:
+- Clear description of the challenge
+- When this pattern applies
+- What the reader wants to achieve
+
+Solution:
+- Concise answer or approach
+- Working code example
+- Configuration if applicable
+
+Explanation:
+- Why the solution works
+- Key concepts involved
+- Trade-offs and alternatives
+
+Variations:
+- Common modifications
+- Related patterns
+- Edge cases and handling
+
+### Cookbook Organization
+
+Organize by task or domain:
+- Authentication recipes
+- Database patterns
+- API integration examples
+- Testing strategies
+
+Include difficulty indicators:
+- Beginner-friendly patterns
+- Intermediate techniques
+- Advanced implementations
+
+Cross-reference related recipes:
+- Link prerequisites
+- Reference complementary patterns
+- Build learning paths
+
+## Documentation Style Guidelines
+
+### Google Developer Documentation Style
+
+Use second person (you):
+- "You can configure..." not "Users can configure..."
+
+Use active voice:
+- "The function returns..." not "The value is returned by..."
+
+Keep sentences short:
+- One idea per sentence
+- Break complex explanations into lists
+
+Use consistent terminology:
+- Define terms on first use
+- Maintain a glossary for projects
+
+### Microsoft Writing Style Guide
+
+Be concise:
+- Remove unnecessary words
+- Get to the point quickly
+
+Use simple words:
+- "use" not "utilize"
+- "start" not "commence"
+
+Format for scanning:
+- Use headings liberally
+- Include bulleted lists
+- Highlight key information
+
+## Documentation Maintenance
+
+### Keeping Docs Current
+
+Tie documentation to code changes:
+- Update docs in same PR as code
+- Include docs in definition of done
+- Review docs during code review
+
+Automate where possible:
+- Generate API docs from code
+- Validate code examples run
+- Check links regularly
+
+Track documentation health:
+- Monitor page views and feedback
+- Track time-to-resolution for support
+- Survey users periodically
+
+### Version Documentation
+
+Align doc versions with software versions:
+- Use versioned documentation systems
+- Mark deprecated content clearly
+- Provide migration guides
+
+Archive old versions:
+- Maintain access to historical docs
+- Clearly indicate version applicability
+- Redirect to current when appropriate
+
+---
+
+Version: 2.0.0
+Last Updated: 2025-12-30

moai_adk/templates/.claude/skills/moai-docs-generation/reference.md

@@ -0,0 +1,234 @@
+# Documentation Generation Reference
+
+## Tool Reference
+
+### Python Documentation Tools
+
+Sphinx:
+- Official site: https://www.sphinx-doc.org/
+- Configuration: conf.py in docs directory
+- Extensions: autodoc, napoleon, viewcode, intersphinx
+- Themes: sphinx_rtd_theme, furo, pydata-sphinx-theme
+- Output formats: HTML, PDF (via LaTeX), ePub, man pages
+
+MkDocs:
+- Official site: https://www.mkdocs.org/
+- Configuration: mkdocs.yml in project root
+- Themes: material (recommended), readthedocs
+- Plugins: search, mkdocstrings, macros, git-revision-date
+- Output formats: HTML static site
+
+mkdocstrings:
+- Official site: https://mkdocstrings.github.io/
+- Handlers: python, crystal, vba
+- Features: Cross-references, signature rendering, source linking
+- Styles: google, numpy, sphinx
+
+interrogate:
+- Purpose: Docstring coverage analysis
+- Configuration: pyproject.toml or .interrogate.yaml
+- Output: Coverage report, badge generation
+- CI integration: Fail builds below threshold
+
+### JavaScript/TypeScript Documentation Tools
+
+TypeDoc:
+- Official site: https://typedoc.org/
+- Configuration: typedoc.json or CLI options
+- Themes: default, or custom themes
+- Plugins: markdown, missing-exports, mermaid
+- Output formats: HTML, JSON, Markdown
+
+JSDoc:
+- Official site: https://jsdoc.app/
+- Configuration: jsdoc.json or conf.json
+- Templates: default, docdash, minami, better-docs
+- Plugins: markdown, summarize
+- Output format: HTML
+
+TSDoc:
+- Official site: https://tsdoc.org/
+- Standard: Unified TypeScript doc comment format
+- Tooling: eslint-plugin-tsdoc, api-extractor
+- Purpose: Standardize TypeScript documentation
+
+### API Documentation Tools
+
+OpenAPI/Swagger:
+- Specification: https://spec.openapis.org/
+- Versions: 3.0.x, 3.1.x (latest)
+- Editors: Swagger Editor, Stoplight Studio
+- Validators: spectral, swagger-cli
+- Code generators: openapi-generator, swagger-codegen
+
+Swagger UI:
+- Official site: https://swagger.io/tools/swagger-ui/
+- Features: Interactive try-it-out, OAuth flows
+- Hosting: Standalone, embedded, SwaggerHub
+- Customization: CSS, plugins
+
+Redoc:
+- Official site: https://redocly.github.io/redoc/
+- Features: Three-panel layout, search, code samples
+- Hosting: Static HTML, React component
+- CLI: redocly bundle, redocly preview
+
+Stoplight:
+- Official site: https://stoplight.io/
+- Features: Design-first API development
+- Tools: Studio (editor), Elements (docs), Prism (mock)
+- Hosting: Cloud or self-hosted
+
+### Static Site Generators
+
+Nextra:
+- Official site: https://nextra.site/
+- Framework: Next.js
+- Features: MDX, file routing, search, i18n
+- Themes: docs, blog
+- Deployment: Vercel (optimized)
+
+Docusaurus:
+- Official site: https://docusaurus.io/
+- Framework: React
+- Features: Versioning, i18n, search, blog
+- Plugins: Search (Algolia, local), PWA, ideal-image
+- Deployment: Any static host
+
+VitePress:
+- Official site: https://vitepress.dev/
+- Framework: Vue 3
+- Features: Fast HMR, Vue in Markdown, theming
+- Built-in: Search, dark mode, carbon ads
+- Deployment: Any static host
+
+MkDocs Material:
+- Official site: https://squidfunk.github.io/mkdocs-material/
+- Framework: MkDocs
+- Features: Search, dark mode, navigation tabs, social cards
+- Plugins: Blog, tags, privacy
+- Deployment: GitHub Pages, any static host
+
+### PDF Generation Tools
+
+WeasyPrint:
+- Official site: https://weasyprint.org/
+- Input: HTML + CSS
+- Features: Print CSS, bookmarks, PDF/A
+- Dependencies: System libraries (cairo, pango)
+
+Pandoc:
+- Official site: https://pandoc.org/
+- Input formats: Markdown, HTML, RST, many more
+- Output formats: PDF (via LaTeX), DOCX, EPUB
+- Features: Templates, filters, citations
+
+rinohtype:
+- Purpose: Sphinx PDF without LaTeX
+- Features: Pure Python, customizable styles
+- Configuration: rinoh.ini
+
+## Configuration Examples
+
+### Sphinx conf.py Essential Settings
+
+Project information:
+- project: Project name string
+- author: Author name string
+- version: Short version string
+- release: Full version string
+
+Extensions:
+- sphinx.ext.autodoc: Auto-generate from docstrings
+- sphinx.ext.napoleon: Google/NumPy docstring support
+- sphinx.ext.viewcode: Add source links
+- sphinx.ext.intersphinx: Link to other projects
+
+Theme configuration:
+- html_theme: Theme name
+- html_theme_options: Theme-specific options
+- html_static_path: Static files directory
+
+### MkDocs mkdocs.yml Essential Settings
+
+Site information:
+- site_name: Displayed site title
+- site_url: Canonical URL
+- repo_url: Source repository link
+
+Theme configuration:
+- theme.name: Theme name (material recommended)
+- theme.palette: Color scheme
+- theme.features: Enable features like tabs, search
+
+Plugins:
+- search: Built-in search
+- mkdocstrings: API documentation
+
+Navigation:
+- nav: List of sections and pages
+
+### TypeDoc typedoc.json Essential Settings
+
+Input:
+- entryPoints: Source files or directories
+- entryPointStrategy: expand, packages, merge
+
+Output:
+- out: Output directory path
+- name: Project name in docs
+
+Behavior:
+- excludePrivate: Hide private members
+- excludeProtected: Hide protected members
+- includeVersion: Show version in docs
+
+## Hosting Options
+
+GitHub Pages:
+- URL pattern: username.github.io/repo
+- Configuration: Repository settings or gh-pages branch
+- Automation: GitHub Actions workflow
+- Custom domains: CNAME file in root
+
+Netlify:
+- Features: Auto-deploy, previews, forms
+- Configuration: netlify.toml or UI
+- Build: Automatic from Git
+- Custom domains: DNS configuration
+
+Vercel:
+- Features: Optimized for Next.js
+- Configuration: vercel.json or UI
+- Build: Automatic from Git
+- Analytics: Built-in web analytics
+
+Read the Docs:
+- Features: Versioning, PDF, search
+- Configuration: .readthedocs.yaml
+- Build: Automatic from Git
+- Hosting: Subdomain or custom domain
+
+## Style Guides
+
+Google Developer Documentation Style Guide:
+- URL: https://developers.google.com/style
+- Key principles: Clear, concise, accessible
+- Voice: Active, second person
+- Formatting: Sentence case headings
+
+Microsoft Writing Style Guide:
+- URL: https://learn.microsoft.com/style-guide/
+- Key principles: Simple, direct, inclusive
+- Voice: Conversational, friendly
+- Formatting: Sentence case, bias-free language
+
+Write the Docs:
+- URL: https://www.writethedocs.org/
+- Resources: Guides, conferences, community
+- Topics: Documentation strategies, tools, careers
+
+---
+
+Version: 2.0.0
+Last Updated: 2025-12-30

moai_adk/templates/.claude/skills/moai-domain-backend/SKILL.md

@@ -1,17 +1,22 @@
 ---
-name: moai-domain-backend
-description: Backend development specialist covering API design, database integration, microservices architecture, and modern backend patterns
+name: "moai-domain-backend"
+description: "Backend development specialist covering API design, database integration, microservices architecture, and modern backend patterns"
 version: 1.0.0
-category: domain
-tags:
- - backend
- - api
- - database
- - microservices
- - architecture
-updated: 2025-11-30
-status: active
-author: MoAI-ADK Team
+category: "domain"
+modularized: false
+tags: ['backend', 'api', 'database', 'microservices', 'architecture']
+updated: 2026-01-08
+allowed-tools:
+  - Read
+  - Write
+  - Edit
+  - Bash
+  - Grep
+  - Glob
+  - mcp__context7__resolve-library-id
+  - mcp__context7__get-library-docs
+status: "active"
+author: "MoAI-ADK Team"
 ---
 
 # Backend Development Specialist
@@ -288,7 +293,7 @@ def create_optimized_engine(database_url: str):
 
 - moai-domain-frontend - Full-stack development integration
 - moai-domain-database - Advanced database patterns
-- moai-integration-mcp - MCP server development for backend services
+- moai-foundation-core - MCP server development patterns for backend services
 - moai-quality-security - Security validation and compliance
 - moai-foundation-core - Core architectural principles