Skip to main content

ops docs

Documentation site management. Manages deployment and freshness of the Docusaurus documentation sites hosted on Azure Container Apps. There are two sites: internal (this site) and crm (vendor-facing CieTrade guide).

Two Sites
SiteAudienceContainer App
internalEngineerswdp-docs.politegrass-38e79dd2.eastus.azurecontainerapps.io
crmCieTrade vendorscrm-docs.politegrass-38e79dd2.eastus.azurecontainerapps.io

Subcommands

SubcommandDescription
statusShow deployment status of documentation sites
deployDeploy a documentation site to Azure Container Apps
generateGenerate visual assets using NotebookLM
freshnessCheck if pages and visual assets are stale

ops docs status

Inspect the current Azure Container App revisions for each docs site.

Show deployment status of internal and crm sites
Terminal
$ops docs status

ops docs deploy

Deploy a documentation site to Azure Container Apps. Wraps the deploy scripts in the wasteology-docs monorepo.

Build and deploy the internal docs site
Terminal
$ops docs deploy internal
Build and deploy the vendor-facing CRM docs site
Terminal
$ops docs deploy crm
Underlying Script

ops docs deploy wraps ~/projects/wasteology-docs/scripts/deploy.sh. You can invoke that script directly if you need finer-grained control.


ops docs generate

Generate visual assets (diagrams, podcasts, etc.) for documentation pages using NotebookLM.

Generate visual assets for the internal docs site
Terminal
$ops docs generate internal

ops docs freshness

Check whether documentation pages and visual assets are stale relative to their source files.

Compare source mtimes against visual-manifest.yaml
Terminal
$ops docs freshness
How Freshness Works

The check compares source file modification times against the visual manifest in sites/<site>/visual-manifest.yaml. If a source file is newer than its recorded asset, the asset is flagged stale.

Common Workflows

🚢

Ship Internal Docs

Edit MDX, run ops docs freshness to confirm assets are current, then ops docs deploy internal.

🤝

Update CRM Site

The crm site is vendor-facing — run ops docs freshness first and review any flagged pages before deploying.

🎨

Refresh Visuals

When source code changes invalidate diagrams, ops docs generate internal rebuilds them via NotebookLM.

🔎

Inspect Revisions

ops docs status shows the live Container App revision so you can confirm a deploy actually rolled out.