Publishing Process for Code Editor

Publish documentation changes by pushing commits to your connected Git repository. Documentation.AI automatically builds and deploys your updates.

How Publishing Works

Documentation.AI monitors your connected Git repository and automatically triggers builds when you push changes:

1. Edit documentation in your code editor
2. Commit changes with Git
3. Push to your repository
4. Documentation.AI builds and deploys automatically
5. Live site updates with your changes

Basic Publishing Workflow

Connect Your Repository

1. Link repository in Documentation.AI dashboard settings
2. Choose deployment branch (usually main)
3. Configure build settings if needed

Publish Changes

Deploy with standard Git workflow:

# Edit documentation files
# Make changes in your code editor

# Commit changes
git add .
git commit -m "Add new API documentation"

# Push to trigger build
git push origin main

Documentation.AI detects the push and automatically builds and deploys your changes.

Build Monitoring

Check Build Status

Monitor deployments in your Documentation.AI dashboard:

• Build logs - View detailed build output and errors
• Build history - Track previous deployments and status
• Preview URLs - Access branch preview builds for testing

Branch Previews

Pull requests automatically generate preview builds:

1. Create pull request with documentation changes
2. Documentation.AI builds a preview version
3. Review preview URL before merging
4. Merge to main for production deployment

Publishing Best Practices

Pre-publish Checklist

Before pushing changes:

• Test links - Verify internal links work correctly
• Check navigation - Ensure new pages appear in documentation.json
• Validate front matter - All pages have title and description
• Review content - Content is accurate and well-formatted
• Preview locally - Use your editor's markdown preview

Common Issues

Build fails:

• Check documentation.json syntax
• Verify all navigation paths reference existing files
• Ensure front matter is properly formatted

Missing pages:

• Add new pages to documentation.json navigation
• Check file paths match navigation configuration
• Verify MDX files have proper front matter

Troubleshooting Deployments

Build Failures

Common causes:

• Invalid documentation.json syntax
• Missing files referenced in navigation
• Malformed front matter in MDX files
• Broken internal links

Solutions:

1. Check build logs in Documentation.AI dashboard
2. Validate JSON syntax in documentation.json
3. Test locally using your editor's markdown preview
4. Fix errors and push again

Rollback Changes

If you need to quickly revert:

# Revert last commit
git revert HEAD
git push origin main

# Or reset to previous working commit
git reset --hard <commit-hash>
git push --force origin main  # Use carefully

Integration with Development Workflow

Team Publishing

Multiple contributors:

• Use feature branches for documentation changes
• Review changes via pull requests
• Merge to main branch for production deployment
• Use preview builds to test changes before merging

Content review process:

1. Create feature branch for documentation updates
2. Make changes and push branch
3. Open pull request with preview build
4. Team reviews content and accuracy
5. Merge to main for production deployment

Next Steps

• Git Workflow: Collaborate on documentation changes
• Organization: Structure your documentation project
• Images & Media: Manage visual content
• Troubleshooting: Resolve publishing issues