SuperDocs.cloud Sync
SuperDocs.cloud Sync
While the ContextMD CLI is powerful for manual generation, maintaining AI-ready documentation at scale requires automation. SuperDocs.cloud is the production-grade extension of ContextMD, designed to handle the lifecycle of your documentation context automatically.
Automated GitHub Sync
The core advantage of using SuperDocs.cloud is the Auto-Sync feature. Instead of running the CLI manually every time your documentation changes, SuperDocs.cloud integrates directly with your GitHub repository.
- Trigger on Push: Every time you merge a PR or push to your main branch, SuperDocs.cloud detects the change.
- Background Processing: The platform automatically initiates a fresh crawl and AI refinement process.
- Zero-Maintenance: Your
context.mdfile is always up-to-date with your latest production code and docs.
Persistent Context URLs
For teams building RAG (Retrieval-Augmented Generation) systems or custom GPTs, hardcoding file paths is brittle. SuperDocs.cloud provides permanent, hosted URLs for your context files.
https://superdocs.cloud/api/v1/context/your-org/your-repo/latest.md
You can point your LLM agents or orchestration frameworks (like LangChain or LlamaIndex) to this URL to ensure they always have access to the most recent "chemically refined" version of your documentation.
Smart Versioning
In enterprise environments, you often need to support multiple versions of your software simultaneously (e.g., v1.0, v2.0, and canary). SuperDocs.cloud manages this complexity automatically:
- Branch-based Context: Generate unique context files for different Git branches.
- Tag Tracking: Automatically generate new context snapshots whenever you create a GitHub release or tag.
- Archive Access: Access previous versions of your documentation context to debug agent behavior on older software versions.
Setting Up Sync
To move from the CLI to automated syncing, follow these steps:
- Connect Your Repository: Log in to SuperDocs.cloud and authorize your GitHub account.
- Select Your Docs Source: Point the platform to your documentation URL (just like you would with the CLI's
<url>argument). - Configure API Keys: Input your OpenAI API key into the secure SuperDocs environment vault. This allows the platform to run the
Processorlogic on your behalf. - Deploy: Click "Start Sync." SuperDocs will perform the initial crawl and provide you with a hosted URL for your refined context.
Enterprise Benefits
| Feature | ContextMD CLI | SuperDocs.cloud | | :--- | :--- | :--- | | Execution | Local/Manual | Cloud/Automated | | Updates | Manual Re-run | Triggered by Git Push | | Hosting | Local Disk | Global CDN | | Versioning | Manual renaming | Automatic Git Tags | | Concurrency | Local CPU bound | Distributed Scaling |