Topolo Docs Topolo Platform
Open workspace

Introduction

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

Find your next step

Topolo Docs explains how to use Topolo applications and build integrations. Start with Quick Start to connect the CLI and run a safe read. Read the Auth action guides for identity and access, or API key options for scoped integrations.

Use Applications for product overviews and task guides. Use Reference for action instructions, input fields, response examples and recovery. The Action reference lets you inspect a credential-scoped contract and, when signed in, review and test its request.

Public and private documentation

Public pages contain the version explicitly published by their owner. Editing a document does not make its draft public. Private workspace and internal documentation require authorized access; a public page or action listing grants no permission to execute an action.

Docs stores immutable document versions. Human pages and public machine reads select the published version. A machine index gives each document's retrieval URL and version identifier so an agent can retrieve and cite that version. Product teams own their runtime behavior and documentation claims.

Documentation for developers and agents

Start with Agents and automation. Inspect the live application and action catalog before preparing an integration. Each selected action should provide its schemas, effects, examples, verification and recovery. Follow its specific guide when you need more detail.

The Docs action index and Auth action index organize the guides already published for those applications. Coverage is still being expanded; an overview does not prove that every action has a complete guide.

Create your own documentation

Sign in and select an authorized Docs workspace. Create a space and documents, maintain versions and translations, and publish only the content intended for a public audience. Consult the Docs action guides for automated workflows and the exact permissions and resource context each operation requires.