Where to Find Documentation for t3code: Complete Guide to the docs/ Directory

The t3code repository stores all user-facing documentation in the docs/ directory at the project root, with the README.md serving as the primary entry point linking to specific guides on release workflows, observability, and development checklists.

The pingdotgg/t3code project maintains comprehensive documentation for users and contributors directly alongside its source code. Whether you need to configure observability, execute a release, or understand the Effect-based tracing patterns, the documentation for t3code resides in a dedicated directory structure that mirrors the project's architecture.

Documentation Location and Structure

The docs/ Directory

All official documentation lives in the docs/ folder at the repository root. This centralized approach ensures that guides for release management, observability configuration, and development standards remain version-controlled alongside the source code.

README.md as the Entry Point

The top-level README.md serves as the primary navigation hub. It contains quick-start instructions and links directly to specialized documentation files within the docs/ directory, including the observability guide and release checklist.

Available Documentation Files

Release Workflow Guide (docs/release.md)

The docs/release.md file contains the step-by-step checklist for building, signing, and publishing the desktop application and CLI package. It covers stable and nightly release procedures, signing setup for macOS and Windows, and OIDC publishing configuration.

Observability Guide (docs/observability.md)

Located at docs/observability.md, this guide explains logging, tracing, and metrics for the server. It documents the local NDJSON trace file format, OTLP export configuration, common span and metric names, and troubleshooting techniques for distributed tracing.

Development Checklist (docs/effect-fn-checklist.md)

The docs/effect-fn-checklist.md provides guidelines for tracing and metric instrumentation when writing new Effect functions. It recommends patterns for creating spans, annotating them with context, and maintaining low metric cardinality to prevent telemetry system overload.

Accessing Documentation from the Command Line

You can access the t3code documentation locally by cloning the repository and navigating to the docs/ directory.

# Clone the repo

git clone https://github.com/pingdotgg/t3code.git
cd t3code

# List all documentation files

ls docs/*.md

This command reveals the three main documentation files: release.md, observability.md, and effect-fn-checklist.md.

Key Implementation Files Referenced in Documentation

The documentation references several critical source files that implement the described functionality:

• apps/server/src/ws.ts – Implements the WebSocket RPC routes, including the serverGetConfig method documented in the README
• packages/contracts/src/server.ts – Defines the TypeScript contracts and response types for server configuration RPC calls
• apps/server/src/observability/Layers/Observability.ts – Wires up the logger, tracer, and optional OTLP exporters described in the observability guide
• apps/server/src/orchestration/Services/OrchestrationEngine.ts – Contains practical examples of Effect span creation and annotation patterns

Summary

• The t3code documentation resides in the docs/ directory at the repository root, with README.md serving as the entry point
• Four primary documentation files cover release workflows (docs/release.md), observability (docs/observability.md), Effect patterns (docs/effect-fn-checklist.md), and general project overview
• Documentation topics correspond to specific implementation files in apps/server/src/ and packages/contracts/src/
• Access documentation locally by cloning the repository and listing docs/*.md

Frequently Asked Questions

Where is the t3code documentation located?

The t3code documentation is located in the docs/ directory at the root of the pingdotgg/t3code repository. The README.md file at the repository root serves as the primary navigation hub, linking to specific guides within the docs/ folder.

How do I access t3code documentation locally?

Clone the repository using git clone https://github.com/pingdotgg/t3code.git, then navigate to the docs/ directory. Use ls docs/*.md to list all markdown documentation files, or open them directly in any text editor or markdown viewer.

What topics does the t3code documentation cover?

The documentation covers release workflows and CI/CD processes, observability configuration including logging and tracing, Effect function patterns for telemetry, and general project setup. Specific files include docs/release.md, docs/observability.md, and docs/effect-fn-checklist.md.

Is there API documentation for t3code?

API documentation is embedded within the source code and high-level overviews. The README.md documents the WebSocket RPC interface including the serverGetConfig method, while detailed TypeScript contracts are defined in packages/contracts/src/server.ts and implemented in apps/server/src/ws.ts.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}