Introduction

Overview of the Topolo documentation platform, what is considered canonical, and where to start.

publicverified 2026-07-28platformonboardingcanonical

What this site is

TopoloDocs is the canonical documentation application for the Topolo platform. Its public reader is generated from the same checked-in Markdown and JSON corpus used by the authenticated React application, agent manifests, and machine-readable artifacts.

What is public versus internal

  • Public docs explain how to build on Topolo, integrate with platform services, and understand the high-level behavior of major applications.
  • Internal docs add architecture, operational flows, debugging procedures, deployment notes, and agent-oriented implementation detail.
  • Both builds come from the same source content model so public and internal material stay aligned.

Where to start

  1. Read Quick Start for the shortest path into the platform.
  2. Read Authentication for token and session flow.
  3. Read API Keys if you are integrating across services.
  4. Use the Service Registry to locate ownership, repos, and app IDs.

Canonical rules

  • Topolo Auth is authoritative for service registration, API key scopes, and API key resource catalogs.
  • TopoloOne is the main operator-facing dashboard for platform controls.
  • Application teams remain authoritative for their product data models and runtime behavior.
  • Repo-local docs are source material unless they are explicitly migrated into this docs site.

Application workspaces

Signed-in teams use /app to create workspace-owned spaces and documents, maintain immutable versions, localize content, search within the active workspace, and publish public snapshots. Workspace selection, organization access, authentication, navigation, and translations use the same shared Topolo platform contracts as other first-party applications.

Change Log / Verification

  • Replaced the Astro runtime with the canonical React, Vite, and TypeScript application architecture on 2026-07-28 while preserving statically generated public, internal, human, and machine documentation routes.

  • Reconciled docs freshness on 2026-06-28 against topolo-platform through 20653c79; latest commit reviewed was 20653c79 feat(auth): bulk availability + app_id-mapping endpoints (seed subrequest cap), with recent context 20653c79 feat(auth): bulk availability + app_id-mapping endpoints (seed subrequest cap); 61117a0d feat(app-shell): add lazy component factory; d8784cfa feat(app-shell): add canonical lazy route factory.