myaidev-method 0.1.0 → 0.2.1

package/.env.example

@@ -3,6 +3,26 @@ WORDPRESS_URL=https://your-wordpress-site.com
 WORDPRESS_USERNAME=your-username
 WORDPRESS_APP_PASSWORD=your-application-password
 
+# PayloadCMS Configuration
+PAYLOADCMS_URL=https://your-payloadcms-site.com
+PAYLOADCMS_EMAIL=your-email@example.com
+PAYLOADCMS_PASSWORD=your-password
+PAYLOADCMS_API_KEY=your-api-key-if-using-api-key-auth
+
+# Coolify Configuration
+COOLIFY_URL=https://your-coolify-instance.com
+COOLIFY_API_KEY=your-coolify-api-key
+
+# Git Configuration (for static site publishing)
+GIT_USER_NAME=Your Name
+GIT_USER_EMAIL=your-email@example.com
+GIT_REMOTE_URL=origin
+
+# Static Site Project Paths (optional, defaults to current directory)
+DOCUSAURUS_PROJECT_PATH=./path-to-docusaurus-project
+MINTLIFY_PROJECT_PATH=./path-to-mintlify-project
+ASTRO_PROJECT_PATH=./path-to-astro-project
+
 # Optional: Default content settings
 DEFAULT_WORD_COUNT=800
 DEFAULT_POST_STATUS=draft

package/PUBLISHING_GUIDE.md

@@ -0,0 +1,521 @@
+# MyAIDev Method - Publishing Guide
+
+Comprehensive guide for publishing content across multiple platforms using MyAIDev Method.
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Platform Support](#platform-support)
+- [Quick Start](#quick-start)
+- [Platform-Specific Guides](#platform-specific-guides)
+- [Configuration](#configuration)
+- [Workflows](#workflows)
+- [Troubleshooting](#troubleshooting)
+
+## Overview
+
+MyAIDev Method provides a unified content publishing system that supports:
+
+- **API-Based CMS**: WordPress, PayloadCMS
+- **Static Site Generators**: Docusaurus, Mintlify, Astro
+- **Deployment**: Coolify self-hosted PaaS
+
+All platforms use a consistent workflow:
+1. Create content (manually or via `/myai-content-writer`)
+2. Configure platform credentials (`/myai-configure`)
+3. Publish content (`/myai-[platform]-publish`)
+
+## Platform Support
+
+### WordPress
+- **Type**: API-based CMS
+- **Publishing**: REST API with Gutenberg blocks
+- **Auth**: Application Passwords
+- **Status**: Draft, Published
+- **Features**: Categories, tags, featured images
+
+### PayloadCMS
+- **Type**: Headless CMS (API-based)
+- **Publishing**: REST API with Lexical rich text
+- **Auth**: JWT tokens or API keys
+- **Status**: Draft, Published
+- **Features**: Custom collections, flexible schemas
+
+### Docusaurus
+- **Type**: Static site generator (git-based)
+- **Publishing**: File operations + git workflow
+- **Content**: Docs, Blog, Pages
+- **Features**: Sidebars, versioning, MDX support
+
+### Mintlify
+- **Type**: Documentation platform (git-based)
+- **Publishing**: File operations + git workflow + mint.json updates
+- **Content**: MDX documentation
+- **Features**: Automatic navigation, API references, icons
+
+### Astro
+- **Type**: Static site generator (git-based)
+- **Publishing**: File operations + git workflow
+- **Content**: Content collections, Pages
+- **Features**: Type-safe frontmatter, image optimization
+
+## Quick Start
+
+### 1. Install Package
+
+```bash
+npm install -g myaidev-method
+# or
+npx myaidev-method init
+```
+
+### 2. Configure Platform
+
+```bash
+/myai-configure
+```
+
+Select your platform and provide credentials.
+
+### 3. Create Content
+
+```bash
+/myai-content-writer "How to build a REST API with Node.js"
+```
+
+### 4. Publish Content
+
+```bash
+# WordPress
+/myai-wordpress-publish "article.md" --status draft
+
+# PayloadCMS
+/myai-payloadcms-publish "article.md" --collection posts
+
+# Docusaurus
+/myai-docusaurus-publish "article.md" --type docs
+
+# Mintlify
+/myai-mintlify-publish "article.md" --nav-section "Guides"
+
+# Astro
+/myai-astro-publish "article.md" --collection blog
+```
+
+## Platform-Specific Guides
+
+### WordPress Publishing
+
+**Configuration** (.env):
+```
+WORDPRESS_URL=https://your-site.com
+WORDPRESS_USERNAME=your-username
+WORDPRESS_APP_PASSWORD=xxxx-xxxx-xxxx-xxxx
+```
+
+**Basic Publishing**:
+```bash
+/myai-wordpress-publish "article.md"
+```
+
+**With Options**:
+```bash
+/myai-wordpress-publish "article.md" \
+  --status published \
+  --categories "Technology,Programming" \
+  --tags "nodejs,api,rest"
+```
+
+**Features**:
+- Automatic Gutenberg block conversion
+- Featured image upload
+- Category and tag management
+- Draft and publish workflow
+
+### PayloadCMS Publishing
+
+**Configuration** (.env):
+```
+PAYLOADCMS_URL=https://cms.your-site.com
+PAYLOADCMS_EMAIL=admin@your-site.com
+PAYLOADCMS_PASSWORD=your-password
+```
+
+**Basic Publishing**:
+```bash
+/myai-payloadcms-publish "article.md"
+```
+
+**With Options**:
+```bash
+/myai-payloadcms-publish "article.md" \
+  --collection articles \
+  --status published \
+  --id 67890
+```
+
+**Features**:
+- Markdown to Lexical conversion
+- Custom collections support
+- JWT authentication
+- Document updates by ID
+
+### Docusaurus Publishing
+
+**Prerequisites**:
+- Docusaurus project with `docusaurus.config.js`
+- Git repository initialized
+
+**Configuration** (.env):
+```
+DOCUSAURUS_PROJECT_PATH=./my-docs
+GIT_USER_NAME=Your Name
+GIT_USER_EMAIL=your-email@example.com
+```
+
+**Publishing to Docs**:
+```bash
+/myai-docusaurus-publish "guide.md"
+```
+
+**Publishing to Blog**:
+```bash
+/myai-docusaurus-publish "post.md" --type blog
+```
+
+**Features**:
+- Automatic frontmatter transformation
+- Sidebar configuration
+- Blog date prefixing
+- Git commit and push
+
+### Mintlify Publishing
+
+**Prerequisites**:
+- Mintlify project with `mint.json`
+- Git repository initialized
+
+**Configuration** (.env):
+```
+MINTLIFY_PROJECT_PATH=./docs
+GIT_USER_NAME=Your Name
+GIT_USER_EMAIL=your-email@example.com
+```
+
+**Basic Publishing**:
+```bash
+/myai-mintlify-publish "guide.mdx"
+```
+
+**With Navigation**:
+```bash
+/myai-mintlify-publish "api-reference.md" \
+  --nav-section "API Reference"
+```
+
+**Features**:
+- Automatic mint.json updates
+- Navigation section management
+- MDX support
+- Icon customization
+
+### Astro Publishing
+
+**Prerequisites**:
+- Astro project with `astro.config.mjs`
+- Git repository initialized
+
+**Configuration** (.env):
+```
+ASTRO_PROJECT_PATH=./my-site
+GIT_USER_NAME=Your Name
+GIT_USER_EMAIL=your-email@example.com
+```
+
+**Publishing to Collection**:
+```bash
+/myai-astro-publish "article.md" --collection blog
+```
+
+**Publishing to Pages**:
+```bash
+/myai-astro-publish "about.md" --pages
+```
+
+**Features**:
+- Content collections support
+- Schema validation
+- Frontmatter transformation (date → pubDate)
+- Draft/published workflow
+
+## Configuration
+
+### Using /myai-configure
+
+Interactive configuration command:
+
+```bash
+/myai-configure
+```
+
+Prompts for:
+1. Platform selection
+2. Credentials and URLs
+3. Optional settings
+
+### Manual Configuration
+
+Edit `.env` file directly:
+
+```env
+# WordPress
+WORDPRESS_URL=https://your-wordpress-site.com
+WORDPRESS_USERNAME=your-username
+WORDPRESS_APP_PASSWORD=your-app-password
+
+# PayloadCMS
+PAYLOADCMS_URL=https://your-payloadcms.com
+PAYLOADCMS_EMAIL=your-email@example.com
+PAYLOADCMS_PASSWORD=your-password
+
+# Git (for static sites)
+GIT_USER_NAME=Your Name
+GIT_USER_EMAIL=your-email@example.com
+
+# Project Paths (optional)
+DOCUSAURUS_PROJECT_PATH=./docs-site
+MINTLIFY_PROJECT_PATH=./docs
+ASTRO_PROJECT_PATH=./blog
+```
+
+## Workflows
+
+### Content Creation → Publishing
+
+```bash
+# 1. Create content
+/myai-content-writer "Building Scalable APIs"
+
+# 2. Review and edit
+# Edit the generated markdown file
+
+# 3. Publish to multiple platforms
+/myai-wordpress-publish "building-scalable-apis.md" --status draft
+/myai-docusaurus-publish "building-scalable-apis.md" --type blog
+/myai-payloadcms-publish "building-scalable-apis.md" --collection articles
+```
+
+### Multi-Platform Publishing
+
+Publish the same content to multiple platforms:
+
+```bash
+FILE="my-article.md"
+
+# WordPress (for SEO and broad reach)
+/myai-wordpress-publish "$FILE" --status published
+
+# Docusaurus (for technical documentation)
+/myai-docusaurus-publish "$FILE" --type docs
+
+# PayloadCMS (for headless CMS API access)
+/myai-payloadcms-publish "$FILE" --collection articles --status published
+```
+
+### Draft → Review → Publish
+
+```bash
+# 1. Publish as draft
+/myai-wordpress-publish "article.md" --status draft
+
+# 2. Review on platform
+# Review content on WordPress admin
+
+# 3. Update to published
+/myai-wordpress-publish "article.md" --status published --id 12345
+```
+
+### Git-Based Deployment
+
+For static sites (Docusaurus, Mintlify, Astro):
+
+```bash
+# 1. Publish to staging
+/myai-docusaurus-publish "guide.md" --branch staging
+
+# 2. Review deployment
+# Check staging environment
+
+# 3. Publish to production
+/myai-docusaurus-publish "guide.md" --branch main
+```
+
+## Script Usage
+
+All publishing operations can also be invoked via npm scripts:
+
+```bash
+# PayloadCMS
+npm run payloadcms:publish -- --file article.md --status published
+
+# Docusaurus
+npm run docusaurus:publish -- --file guide.md --type docs
+
+# Mintlify
+npm run mintlify:publish -- --file api-ref.md --nav-section "API"
+
+# Astro
+npm run astro:publish -- --file post.md --collection blog
+```
+
+## Troubleshooting
+
+### Authentication Failures
+
+**WordPress**:
+- Verify Application Password is correct
+- Check URL includes `https://`
+- Ensure WordPress REST API is enabled
+
+**PayloadCMS**:
+- Verify email/password combination
+- Check PayloadCMS instance is accessible
+- Try using API key instead of password
+
+### Git Errors
+
+**Uncommitted Changes**:
+```bash
+# Commit or stash existing changes first
+git stash
+# Then retry publishing
+```
+
+**Push Rejected**:
+```bash
+# Pull latest changes first
+cd /path/to/project
+git pull --rebase
+# Then retry publishing
+```
+
+### Frontmatter Issues
+
+**Docusaurus**:
+- Ensure `title` field is present
+- Check `sidebar_position` is a number
+
+**Astro**:
+- Verify `pubDate` is ISO 8601 format
+- Check collection schema requirements
+
+**Mintlify**:
+- Ensure `title` field is present
+- Verify MDX syntax is valid
+
+### Platform Detection
+
+If platform not detected:
+
+```bash
+# Specify project path explicitly
+/myai-docusaurus-publish "guide.md" --project /path/to/docs
+
+# Or set in .env
+echo "DOCUSAURUS_PROJECT_PATH=/path/to/docs" >> .env
+```
+
+## Best Practices
+
+1. **Always start with drafts**: Publish as draft first, review, then publish
+2. **Use consistent frontmatter**: Maintain standard frontmatter across content
+3. **Test on staging**: Use git branches for staging/production workflow
+4. **Version control**: Commit content to git before publishing
+5. **Backup regularly**: Keep local copies of all content
+6. **Monitor deployments**: Check build status after git push
+7. **Validate schemas**: Test frontmatter against platform requirements
+
+## Advanced Topics
+
+### Custom Frontmatter
+
+Each platform accepts different frontmatter fields. Common fields:
+
+```yaml
+---
+# Universal
+title: "Article Title"
+description: "Article description"
+date: 2025-10-16
+
+# WordPress-specific
+categories: ["Tech", "Programming"]
+tags: ["nodejs", "api"]
+status: draft
+
+# Docusaurus-specific
+sidebar_position: 1
+sidebar_label: "Custom Label"
+
+# Astro-specific
+pubDate: 2025-10-16T00:00:00Z
+draft: false
+author: "Author Name"
+
+# Mintlify-specific
+icon: "rocket"
+iconType: "solid"
+---
+```
+
+### Automated Publishing
+
+Create shell scripts for automated workflows:
+
+```bash
+#!/bin/bash
+# publish-everywhere.sh
+
+FILE=$1
+
+/myai-wordpress-publish "$FILE" --status published
+/myai-payloadcms-publish "$FILE" --status published
+/myai-docusaurus-publish "$FILE" --type blog
+```
+
+### CI/CD Integration
+
+Integrate with GitHub Actions, GitLab CI, or other CI/CD:
+
+```yaml
+# .github/workflows/publish.yml
+name: Publish Documentation
+on:
+  push:
+    paths:
+      - 'content/**'
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: npm install -g myaidev-method
+      - run: /myai-docusaurus-publish content/*.md
+```
+
+## Support
+
+- **Documentation**: See platform-specific docs (WORDPRESS_ADMIN_SCRIPTS.md, etc.)
+- **Issues**: https://github.com/myaione/myaidev-method/issues
+- **NPM**: https://www.npmjs.com/package/myaidev-method
+- **GitHub**: https://github.com/myaione/myaidev-method
+
+## Next Steps
+
+1. Configure your platforms: `/myai-configure`
+2. Create test content: `/myai-content-writer "Test Article"`
+3. Publish to staging/draft first
+4. Review and iterate
+5. Publish to production
+
+Happy publishing! 🚀