T Topolo Docs
application public active Verified 2026-05-11

TopoloDocs

Canonical documentation, system registry, machine-readable platform evidence, and docs validation surface for the Topolo Platform.

Documentation Map

What It Is

Canonical documentation, system registry, machine-readable platform evidence, and docs validation surface for the Topolo Platform.

Architecture

Owners: platform

Source repos: PlatformApplications/TopoloDocs

Dependencies: topolo-auth, cloud-control

Repo shape

  • PlatformApplications/TopoloDocs/astro.config.mjs
  • PlatformApplications/TopoloDocs/functions/
  • PlatformApplications/TopoloDocs/package-lock.json
  • PlatformApplications/TopoloDocs/package.json
  • PlatformApplications/TopoloDocs/pnpm-lock.yaml
  • PlatformApplications/TopoloDocs/public/
  • PlatformApplications/TopoloDocs/scripts/
  • PlatformApplications/TopoloDocs/src/
  • PlatformApplications/TopoloDocs/templates/
  • PlatformApplications/TopoloDocs/test/
  • PlatformApplications/TopoloDocs/topolo.cloudcontrol.json
  • PlatformApplications/TopoloDocs/tsconfig.json
  • PlatformApplications/TopoloDocs/vitest.config.ts

Runtime Surfaces

Hosts:

https://docs.topolo.app https://docs.stg.topolo.us

No wrangler surface was discovered under the registered repo paths.

API Reference

Coverage: curated

Source: PlatformApplications/TopoloDocs/src/content/internal/platform/docs-governance.mdx

Source exists in repo: yes

TopoloDocs owns the canonical published docs, internal handbooks, system registry JSON, generated Auth catalog snapshot, and security/privacy evidence reports used by launch and deployment gates.

App API page: /reference/apps/topolo-docs

This system currently relies on a curated or README-derived contract surface instead of a source-controlled OpenAPI spec.

Auth and Permissions

Depends on Topolo Auth: yes

Service IDs:

srv_topolo_docs

API key scopes

docs.read

View documentation pages and metadata

Resource pattern: none

docs.write

Author and edit documentation content

Resource pattern: none

validation.invoke

Run documentation validation and link checks

Resource pattern: none

Service permissions

docs:read, docs:write, validation:invoke

Data Ownership

No storage bindings were derived from wrangler configuration.

Queues / Cron / Workflows

Queue bindings:

No queue bindings were detected.

Cron triggers

No cron triggers were detected.

Workflow signals

No explicit queue/workflow script or cron signal was discovered.

Environment Variables and Bindings

Environment variables:

No environment variables were derived from wrangler configuration.

All wrangler bindings

No bindings were derived from wrangler configuration.

Deployments

Deployment environments: default only or not declared

Routes: workers.dev or Pages-only delivery

Observability enabled: no explicit setting found

Build and deploy commands

  • build — PlatformApplications/TopoloDocs/package.json :: node -e "fs.rmSync('dist', { recursive: true, force: true })" && astro build && node ./scripts/write-manifest.mjs && node ./scripts/write-security-assurance-report.mjs
  • build:production — PlatformApplications/TopoloDocs/package.json :: npm run security-gate:production && npm run build
  • build:publication — PlatformApplications/TopoloDocs/package.json :: npm run security-gate:publication && npm run build
  • deploy — PlatformApplications/TopoloDocs/package.json :: node -e 'console.error("\n✘ Bare \"deploy\" is disabled. Use deploy:staging or deploy:production.\n"); process.exit(1)'
  • deploy:staging — PlatformApplications/TopoloDocs/package.json :: DEPLOY_ENVIRONMENT=staging CLOUDFLARE_ACCOUNT_ID=4f4e1c69a3830946f9fea7b1eb7531ac python3 .github/scripts/standard_deploy.py local-deploy
  • deploy:gated — PlatformApplications/TopoloDocs/package.json :: npm run build:production && node ./scripts/deploy-pages.mjs

Failure Modes

  • No wrangler.toml surface was discovered under the registered repo paths.
  • Neither OpenAPI nor README-derived interface detail was found.

Debugging Runbooks

Start with these entrypoints:

  • PlatformApplications/TopoloDocs/src/content/internal/platform/docs-governance.mdx
  • PlatformApplications/TopoloDocs/package.json

Change Log / Verification

Lifecycle: active

Last verified: 2026-05-11

Any code change to this system is expected to update the canonical docs in PlatformApplications/TopoloDocs and refresh the verification date.