myaidev-method 0.2.23 → 0.2.24-1

package/src/templates/docs/visual-generation-guide.md

@@ -0,0 +1,248 @@
+# Visual Generation Guide
+
+A guide to generating visual content (images, diagrams, videos) with the MyAIDev Method.
+
+## Overview
+
+The visual content generation workflow integrates with multiple AI image and video generation services to create professional visuals for your content.
+
+## Prerequisites
+
+- Visual workflow installed (`npx myaidev-method visual --claude`)
+- API keys for at least one visual generation service
+
+## Supported Services
+
+### Image Generation
+
+| Service | Best For | API Required |
+|---------|----------|--------------|
+| Gemini | General images, diagrams | Google AI API |
+| Imagen | High-quality photographs | Google Cloud |
+| FLUX | Creative, artistic images | Replicate/fal.ai |
+
+### Video Generation
+
+| Service | Best For | API Required |
+|---------|----------|--------------|
+| Veo | Professional video content | Google AI API |
+
+## Configuration
+
+### Setting Up API Keys
+
+Add to your `.env` file:
+
+```env
+# Google AI (Gemini, Imagen, Veo)
+GOOGLE_AI_API_KEY=your-google-ai-key
+
+# Replicate (FLUX)
+REPLICATE_API_TOKEN=your-replicate-token
+
+# fal.ai (FLUX alternative)
+FAL_KEY=your-fal-key
+```
+
+## Generating Images
+
+### Basic Usage
+
+```bash
+/myai-generate-visual "A modern office workspace with natural lighting" --type image
+```
+
+### With Options
+
+```bash
+/myai-generate-visual "Product photography of a smartphone" \
+  --type image \
+  --service imagen \
+  --aspect-ratio 1:1 \
+  --style photorealistic
+```
+
+### Image Options
+
+| Option | Description | Values |
+|--------|-------------|--------|
+| `--service` | Generation service | gemini, imagen, flux |
+| `--aspect-ratio` | Output ratio | 1:1, 16:9, 4:3, 9:16 |
+| `--style` | Visual style | photorealistic, artistic, diagram |
+| `--output` | Output filename | Custom filename |
+
+## Generating Diagrams
+
+### Technical Diagrams
+
+```bash
+/myai-generate-visual "System architecture diagram showing microservices" \
+  --type diagram \
+  --format mermaid
+```
+
+### Flowcharts
+
+```bash
+/myai-generate-visual "User authentication flow" \
+  --type flowchart \
+  --format svg
+```
+
+### Diagram Types
+
+- Architecture diagrams
+- Flowcharts
+- Sequence diagrams
+- Entity relationship diagrams
+- Mind maps
+- Organizational charts
+
+## Generating Videos
+
+### Basic Video
+
+```bash
+/myai-generate-visual "A timelapse of clouds moving across a mountain landscape" \
+  --type video \
+  --duration 10
+```
+
+### Video Options
+
+| Option | Description | Values |
+|--------|-------------|--------|
+| `--duration` | Video length | 5-60 seconds |
+| `--resolution` | Output quality | 720p, 1080p |
+| `--fps` | Frame rate | 24, 30, 60 |
+
+## Prompt Engineering
+
+### Effective Image Prompts
+
+**Good:**
+```
+Professional headshot of a business executive,
+soft studio lighting, neutral background,
+sharp focus, high resolution
+```
+
+**Less Effective:**
+```
+Person photo
+```
+
+### Key Elements
+
+1. **Subject** - What is the main focus?
+2. **Style** - Photorealistic? Illustration? Diagram?
+3. **Composition** - Close-up? Wide shot? Angle?
+4. **Lighting** - Natural? Studio? Dramatic?
+5. **Quality** - Resolution, detail level
+6. **Mood** - Professional? Casual? Energetic?
+
+## Integration with Content
+
+### Automatic Image Generation
+
+When writing content, request images inline:
+
+```markdown
+## Introduction
+
+[Generate: Hero image showing AI-assisted content creation]
+
+The future of content creation...
+```
+
+### Batch Generation
+
+```bash
+# Generate all images for an article
+/myai-generate-visual --from-content ./content/my-article.md
+```
+
+## Best Practices
+
+### For Blog Posts
+
+- Hero images: 16:9 ratio, high quality
+- In-article images: Relevant, not stock-looking
+- Diagrams: Clear, labeled, consistent style
+
+### For Social Media
+
+- Square images (1:1) for Instagram
+- Wide images (16:9) for Twitter/X
+- Vertical (9:16) for Stories/Reels
+
+### For Documentation
+
+- Diagrams: SVG or PNG with transparent background
+- Screenshots: Annotated, cropped appropriately
+- Icons: Consistent style throughout
+
+## Troubleshooting
+
+### Generation Failed
+
+**Symptoms:** API error or timeout
+
+**Solutions:**
+1. Check API key validity
+2. Verify service is available
+3. Simplify prompt
+4. Try different service
+
+### Poor Quality Output
+
+**Symptoms:** Blurry, wrong subject, artifacts
+
+**Solutions:**
+1. Be more specific in prompt
+2. Add style keywords
+3. Try different aspect ratio
+4. Use higher quality service
+
+### Content Policy Violations
+
+**Symptoms:** Request rejected
+
+**Solutions:**
+1. Review content policies
+2. Rephrase prompt
+3. Avoid restricted content
+
+## API Reference
+
+### VisualGenerator
+
+```javascript
+import { VisualGenerator } from 'myaidev-method';
+
+const generator = new VisualGenerator();
+
+// Generate image
+const image = await generator.generateImage({
+  prompt: 'Description of image',
+  service: 'imagen',
+  aspectRatio: '16:9'
+});
+
+// Generate diagram
+const diagram = await generator.generateDiagram({
+  prompt: 'System architecture',
+  format: 'mermaid'
+});
+
+// Generate video
+const video = await generator.generateVideo({
+  prompt: 'Video description',
+  duration: 10
+});
+```
+
+## Related Documentation
+
+- [Content Creation Guide](content-creation-guide.md)
+- [WordPress Publishing Guide](wordpress-publishing-guide.md)

package/src/templates/docs/wordpress-publishing-guide.md

@@ -0,0 +1,208 @@
+# WordPress Publishing Guide
+
+A guide to publishing content to WordPress using the MyAIDev Method.
+
+## Overview
+
+The MyAIDev Method integrates directly with WordPress REST API, allowing you to publish content without leaving your development environment.
+
+## Prerequisites
+
+- WordPress site with REST API enabled
+- Application Password created for your user
+- MyAIDev Method WordPress workflow installed
+
+## Configuration
+
+### Setting Up Credentials
+
+Run the configuration wizard:
+
+```bash
+/myai-configure wordpress
+```
+
+Or manually set environment variables in `.env`:
+
+```env
+WORDPRESS_URL=https://your-site.com
+WORDPRESS_USERNAME=your-username
+WORDPRESS_APP_PASSWORD=xxxx xxxx xxxx xxxx xxxx xxxx
+WORDPRESS_DEFAULT_STATUS=draft
+```
+
+### Creating an Application Password
+
+1. Log into WordPress admin
+2. Go to Users → Profile
+3. Scroll to "Application Passwords"
+4. Enter a name (e.g., "MyAIDev Method")
+5. Click "Add New Application Password"
+6. Copy the generated password (spaces are OK)
+
+## Publishing Content
+
+### Basic Publishing
+
+```bash
+/myai-wordpress-publish ./content/my-article.md
+```
+
+### With Options
+
+```bash
+/myai-wordpress-publish ./content/my-article.md --status publish --categories "Technology,AI"
+```
+
+### Publishing Options
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `--status` | Post status (draft, publish, pending) | draft |
+| `--categories` | Comma-separated categories | None |
+| `--tags` | Comma-separated tags | None |
+| `--featured-image` | Path to featured image | None |
+
+## Content Format
+
+### Frontmatter
+
+The publisher reads YAML frontmatter from your markdown files:
+
+```yaml
+---
+title: Your Article Title
+description: Meta description for SEO
+date: 2024-01-15
+author: Your Name
+categories:
+  - Technology
+  - AI
+tags:
+  - machine-learning
+  - automation
+status: draft
+---
+```
+
+### Supported Markdown
+
+- Headings (H1-H6)
+- Bold and italic text
+- Links and images
+- Code blocks
+- Bullet and numbered lists
+- Blockquotes
+
+## Batch Publishing
+
+### Using Content Coordinator
+
+```bash
+# Verify and publish all approved content
+/myai-coordinate-content ./content-queue/
+```
+
+### Workflow
+
+1. Place markdown files in queue directory
+2. Run coordinator to verify quality
+3. Approved content publishes automatically
+4. Reports generated with URLs and status
+
+## Managing Posts
+
+### Search Posts
+
+```javascript
+// Via WordPress client
+const client = new WordPressClient();
+const results = await client.searchPosts('keyword');
+```
+
+### Update Existing Post
+
+```bash
+/myai-wordpress-publish ./content/updated-article.md --post-id 123
+```
+
+### Get Categories
+
+```bash
+# List available categories
+/myai-wordpress-publish --list-categories
+```
+
+## Troubleshooting
+
+### Authentication Failed
+
+**Symptoms:** 401 or 403 errors
+
+**Solutions:**
+1. Verify username is correct
+2. Regenerate Application Password
+3. Check user has publish permissions
+4. Ensure REST API is enabled
+
+### Connection Refused
+
+**Symptoms:** ECONNREFUSED or timeout
+
+**Solutions:**
+1. Verify site URL is correct
+2. Check if site is accessible
+3. Try with/without `www.`
+4. Check for firewall blocks
+
+### Content Not Publishing
+
+**Symptoms:** Draft created but not published
+
+**Solutions:**
+1. Check `--status` flag
+2. Verify user has publish capability
+3. Check for required fields (title, content)
+
+## Security Best Practices
+
+1. **Use Application Passwords** - Never use your main password
+2. **Limit Permissions** - Create a dedicated publishing user
+3. **Secure Storage** - Keep credentials in `.env` (add to `.gitignore`)
+4. **Regular Rotation** - Regenerate passwords periodically
+5. **HTTPS Only** - Always use HTTPS for your WordPress site
+
+## API Reference
+
+### WordPressClient
+
+```javascript
+import { WordPressClient } from 'myaidev-method';
+
+const client = new WordPressClient({
+  siteUrl: 'https://your-site.com',
+  username: 'your-username',
+  appPassword: 'your-app-password'
+});
+
+// Publish post
+const result = await client.publishPost({
+  title: 'My Article',
+  content: 'Article content...',
+  status: 'draft'
+});
+
+// Search posts
+const posts = await client.searchPosts('keyword');
+
+// Update post
+await client.updatePost(postId, { title: 'New Title' });
+
+// Get categories
+const categories = await client.getCategories();
+```
+
+## Related Documentation
+
+- [Content Creation Guide](content-creation-guide.md)
+- [Visual Generation Guide](visual-generation-guide.md)