documcp

--- documcp: last_updated: "2025-11-20T00:46:21.955Z" last_validated: "2025-11-20T00:46:21.955Z" auto_updated: false update_frequency: monthly --- # How to Verify and Monitor Your Documentation Deployment This guide shows you how to verify your deployed documentation site and monitor deployment health using DocuMCP's built-in tools. ## Quick Setup ```bash # Verify your deployment: "verify my GitHub Pages deployment and check for issues" ``` ## Deployment Verification Overview DocuMCP provides deployment verification and health monitoring capabilities: ### Verification Features - **Deployment Status**: Check if GitHub Pages deployment succeeded - **Site Accessibility**: Verify your site is reachable - **Content Validation**: Check documentation accuracy and links - **Build Health**: Monitor deployment pipeline health ### Health Monitoring - **Deployment Analytics**: Track success/failure rates over time - **Build Time Monitoring**: Monitor deployment performance - **Error Detection**: Identify common deployment issues ## Setup Methods ### Method 1: Deployment Verification ```bash # Verify deployment status: "verify my GitHub Pages deployment and check for issues" ``` This will: 1. Check GitHub Pages deployment status 2. Verify site accessibility 3. Validate documentation links 4. Check content accuracy 5. Generate health report ### Method 2: Content Validation #### Step 1: Link Checking ```bash # Check documentation links: "check all my documentation links for broken references" ``` #### Step 2: Content Accuracy ```bash # Validate content accuracy: "validate my documentation content for errors and inconsistencies" ``` #### Step 3: Deployment Health ```bash # Check deployment health: "analyze my deployment health and provide recommendations" ``` ## Deployment Health Monitoring ### Using MCP Tools ```typescript // Check deployment verification import { verifyDeployment } from "./dist/tools/verify-deployment.js"; const verification = await verifyDeployment({ repository: "username/repo-name", url: "https://username.github.io/repo-name", }); // Check documentation links import { checkDocumentationLinks } from "./dist/tools/check-documentation-links.js"; const linkCheck = await checkDocumentationLinks({ documentation_path: "./docs", check_external_links: true, check_internal_links: true, }); ``` ### Key Health Indicators - **Deployment Success**: GitHub Pages build status - **Link Health**: Broken/working link ratio - **Content Accuracy**: Documentation validation score - **Build Performance**: Deployment time trends ## Troubleshooting ### Common Issues **Problem**: Deployment verification fails **Solution**: Check GitHub Pages settings and repository permissions **Problem**: Link checker reports false broken links **Solution**: Verify external link accessibility and adjust timeout settings **Problem**: Content validation shows low accuracy **Solution**: Review code examples and update outdated documentation **Problem**: Health score seems low **Solution**: Analyze deployment failures and optimize configurations ## Advanced Configuration ### Custom Validation ```yaml # validation-config.yml validation: links: timeout: 30s check_external: true check_internal: true content: accuracy_threshold: 70 include_code_validation: true deployment: health_threshold: 80 track_build_times: true ``` ### Integration Options - **GitHub Actions**: Automated validation in CI/CD workflows - **MCP Tools**: Direct integration with documcp verification tools - **Custom Scripts**: Tailored monitoring solutions ## Best Practices 1. **Set Realistic Thresholds**: Avoid alert fatigue 2. **Monitor Key Pages**: Focus on critical documentation 3. **Regular Reviews**: Check metrics weekly 4. **Automated Responses**: Set up auto-healing where possible ## Next Steps - [Custom Domains Setup](custom-domains.md) - [SEO Optimization](seo-optimization.md) - [Analytics Setup](analytics-setup.md) - [Troubleshooting Guide](../how-to/troubleshooting.md)