# Home

Welcome to the Telepact docs. Use this page to find the right path based on
what you are trying to do: learn the basics, design a schema, build clients and
servers, or place Telepact inside a larger service.

## Start here

- [Quickstart](./example.md) for the fastest end-to-end example
- [Learn Telepact by Example](./01-learn-by-example/README.md) for a guided tour
- [Demos](../example/README.md) for runnable end-to-end examples

## Common paths

- **I want the quickest possible start**
  - [Quickstart](./example.md)
  - Then [Learn Telepact by Example](./01-learn-by-example/README.md)
- **I want browser + Node usage**
  - [Transport Guide](./03-build-clients-and-servers/01-transports.md) for browser TypeScript + `fetch` and WebSocket patterns
  - [Client Paths](./03-build-clients-and-servers/02-client-paths.md) for choosing between plain JSON, runtime libraries, schema-backed mocks, and optional generated code
  - [TypeScript library README](../lib/ts/README.md) for the runtime client/server API
- **I want schema-backed integration confidence**
  - [Tooling Workflow](./03-build-clients-and-servers/04-tooling-workflow.md) for the fetch/compare/mock/codegen workflow
  - [Learn by Example: Mock server](./01-learn-by-example/04-mocking-an-integration/14-mock-server.md)
  - [Learn by Example: Verify](./01-learn-by-example/04-mocking-an-integration/17-verify.md)
- **I need auth**
  - [Auth Guide](./03-build-clients-and-servers/05-auth.md) for Telepact's canonical auth convention
  - [`example/py-http-cookie-auth`](../example/py-http-cookie-auth/README.md) for one browser/session-cookie example
- **I need operating-boundary guidance**
  - [Operating Boundary Guide](./04-operate/01-production-guide.md)
  - [Runtime Error Guide](./04-operate/02-runtime-errors.md)
- **I need tooling or optional code generation**
  - [Tooling Workflow](./03-build-clients-and-servers/04-tooling-workflow.md)
  - [CLI](../sdk/cli/README.md)
  - [Learn by Example: Code generation](./01-learn-by-example/07-code-generation/21-code-generation.md)
- **I want runnable examples**
  - [Demos](../example/README.md)
  - [Transport Guide](./03-build-clients-and-servers/01-transports.md) for the guide-to-demo mapping

## Design APIs

- [Schema Writing Guide](./02-design-apis/01-schema-guide.md) for the full schema language
- [Core Concepts](./02-design-apis/02-core-concepts.md) for Telepact's message model, schema
  role, headers, links, select, and binary at a high level
- [Extensions overview](./02-design-apis/03-extensions.md) for Telepact's reserved `_ext.*_` types
- [`_ext.Select_`](./02-design-apis/04-select-extension.md) for response selection
- [Mock extensions](./02-design-apis/05-mock-extensions.md) for `_ext.Call_` and `_ext.Stub_`
- [JSON Schema](../common/json-schema.json) for schema-file validation

## Build clients and servers

- [Transport Guide](./03-build-clients-and-servers/01-transports.md) for HTTP and WebSocket wiring patterns
- [Client Paths](./03-build-clients-and-servers/02-client-paths.md) for choosing between plain JSON, client
  libraries, schema-backed mocks, and optional generated code
- [Server Paths](./03-build-clients-and-servers/03-server-paths.md) for choosing a runtime and wiring a server
- [Auth Guide](./03-build-clients-and-servers/05-auth.md) for Telepact's canonical auth convention
- [Tooling Workflow](./03-build-clients-and-servers/04-tooling-workflow.md) for `fetch`, `compare`, `mock`, and
  `codegen`

### Libraries

- [TypeScript](../lib/ts/README.md)
- [Python](../lib/py/README.md)
- [Java](../lib/java/README.md)
- [Go](../lib/go/README.md)

### SDK tools

- [CLI](../sdk/cli/README.md)
    - Fetch schemas, compare versions, run schema-backed mocks, and optionally
      generate code from the command line
- [Browser Console](../sdk/console/README.md)
    - Browse docs and submit live requests against a running Telepact server
- [Prettier Plugin](../sdk/prettier/README.md)
    - Format checked-in Telepact schema files consistently

## Operate

- [Operating Boundary Guide](./04-operate/01-production-guide.md) for Telepact-specific auth,
  compatibility, and observability boundaries
- [Runtime Error Guide](./04-operate/02-runtime-errors.md) for local/runtime debugging
- [Versions](./04-operate/03-versions.md) for the latest published library and SDK versions

## Background and reference

- [FAQ](./05-background-and-reference/01-faq.md) for Telepact's more unusual design decisions
- [Motivation](./05-background-and-reference/02-motivation.md) for the ecosystem goals and tradeoffs