Skip to main content

Status Workflow

This workflow keeps the Platform Status page, ClickUp “Platform Docs Hub,” and daily operations aligned.

Data Flow​

  1. Source File: docs-site/src/data/status.json holds structured status data.
  2. Rendered Page: docs/status/status.mdx imports StatusOverview component to display that data.
  3. ClickUp Sync: Platform Docs Hub → Technical Reference task includes a link to the live docs and notes about the latest update.

Update Checklist (EOD)​

  1. Update status.json with environment state, integration status, recent changes, next actions.
  2. Run a local docs preview (cd docs-site && npm run start) if you want to verify formatting.
  3. Commit the changes (or stage for review).
  4. Run node scripts/sync-status-to-clickup.js to post the structured summary to ClickUp.
  5. Schedule the same command via Render cron (nightly) so ClickUp stays aligned automatically.
  6. Add a brief daily summary comment in the Daily Runbook task linking back to the updated docs.

Automation Ideas​

  • Script to append the day’s ClickUp summary to recentChanges.
  • GitHub Action to deploy docs site on push to main.
  • Render cron job to ping key health endpoints and update status.json accordingly.

Keeping this status workflow consistent ensures both humans and automation have the same snapshot of platform health.***