Getting StartedUpdated July 3, 2026
Publishing Process
guidepublishingdeploymentcicdmkdocsverificationtroubleshooting
Publishing process
This guide explains how documentation changes are published, verified, and troubleshooted in MEGADOC.
Prerequisites
- PR is merged into the main branch
- All CI checks have passed
Steps
- CI/CD pipeline builds the documentation using MkDocs
- Site is deployed to the hosting platform (e.g., Azure, GitHub Pages)
- Search indexes and caches are updated as needed
Verification
- Visit the documentation site and confirm your changes are live
- Check for build or deployment errors in the CI/CD logs if the site is not updated
Rollback/Troubleshooting
- If deployment fails, review the CI/CD logs for errors
- Revert the problematic commit or fix the issue and push a new commit to main
For submodule and advanced publishing, see Submodules Guide.