# Where to Find the UditAkhourii/adhd Documentation: A Complete Guide

> Find the UditAkhourii/adhd documentation easily. Explore Markdown files in the documentation directory and key README and SKILL files for comprehensive guides.

- Repository: [Udit Akhouri/adhd](https://github.com/UditAkhourii/adhd)
- Tags: how-to-guide
- Published: 2026-07-30

---

**The UditAkhourii/adhd documentation is located entirely within the repository's `documentation/` directory as version-controlled Markdown files, with supplementary guides available in [`README.md`](https://github.com/UditAkhourii/adhd/blob/main/README.md) and [`skills/adhd/SKILL.md`](https://github.com/UditAkhourii/adhd/blob/main/skills/adhd/SKILL.md).**

The UditAkhourii/adhd repository is an open-source TypeScript framework for LLM-based agent workflows. Unlike projects that host documentation on external sites, this project keeps all guides, API references, and architectural explanations directly in the codebase where they stay synchronized with every release.

## Documentation Structure and File Locations

All documentation resides in the `documentation/` directory at the repository root. These Markdown files cover installation, usage, and conceptual depth:

- **[`documentation/quickstart.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/quickstart.md)** – CLI and library usage examples
- **[`documentation/install.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/install.md)** – Setup instructions including npm global installation
- **[`documentation/how-it-works.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/how-it-works.md)** – System architecture and reasoning flow
- **[`documentation/api.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/api.md)** – CLI flags and TypeScript API reference
- **[`documentation/when-to-use.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/when-to-use.md)** – Use case guidance and decision criteria
- **[`documentation/frames.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/frames.md)** – Deep dive into the frames conceptual model
- **[`documentation/evals.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/evals.md)** – Evaluation methodology and benchmarking procedures
- **[`documentation/vs-cot-and-tot.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/vs-cot-and-tot.md)** – Comparison between Chain-of-Thought and Tree-of-Thought approaches

Additional critical files include the **[`README.md`](https://github.com/UditAkhourii/adhd/blob/main/README.md)** at the root for high-level project overview and **[`skills/adhd/SKILL.md`](https://github.com/UditAkhourii/adhd/blob/main/skills/adhd/SKILL.md)** for agent skill configuration.

## Quick Start and Installation Guides

The [`documentation/quickstart.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/quickstart.md) file provides the essential paths to get running. For CLI usage, as implemented in [`src/cli.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/cli.ts), you first set your Anthropic API key and install the global package:

```bash
export ANTHROPIC_API_KEY="your-api-key"
npm install -g adhd-agent
adhd "design a retry strategy for an LLM request that sometimes hangs"

```

To embed the library in your own TypeScript project, import from `adhd-agent` and use the `run()` function defined in [`src/engine.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/engine.ts):

```typescript
import { renderText, run } from "adhd-agent";

const result = await run({
  problem: "How should we shard this queue under bursty load?",
  topK: 3,
});
console.log(renderText(result));

```

## Core Concepts: Frames, Evaluation, and Reasoning

For understanding the system's theoretical underpinnings, consult [`documentation/frames.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/frames.md) for the **frames** abstraction and [`documentation/vs-cot-and-tot.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/vs-cot-and-tot.md) for comparisons between Chain-of-Thought (CoT) and Tree-of-Thought (ToT) methodologies. The [`documentation/evals.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/evals.md) file details the benchmarking procedures used to validate output quality.

## API Reference and Skill Integration

The [`documentation/api.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/api.md) file documents both command-line flags handled in [`src/cli.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/cli.ts) and the programmatic interface exposed by [`src/engine.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/engine.ts). For agent integration, [`skills/adhd/SKILL.md`](https://github.com/UditAkhourii/adhd/blob/main/skills/adhd/SKILL.md) defines the skill metadata that enables discovery by agent frameworks:

```bash
npx skills add UditAkhourii/adhd

# After restarting the agent:

/adhd "design a rate limiter that survives a leader election"

```

## Source Code as Documentation

When the Markdown guides require clarification, refer directly to the source implementation:

- **[`src/cli.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/cli.ts)** – Command-line argument parsing and entry point
- **[`src/engine.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/engine.ts)** – Core orchestration of LLM calls, framing, and idea generation
- **[`src/render.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/render.ts)** – Output formatting for human-readable text or JSON
- **[`src/llm.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/llm.ts)** – Anthropic API wrapper handling retries and streaming responses

These files are extensively commented and serve as living documentation for the system's internal behavior.

## Summary

- The UditAkhourii/adhd documentation lives in the `documentation/` directory at the repository root
- Key files include [`quickstart.md`](https://github.com/UditAkhourii/adhd/blob/main/quickstart.md), [`api.md`](https://github.com/UditAkhourii/adhd/blob/main/api.md), [`how-it-works.md`](https://github.com/UditAkhourii/adhd/blob/main/how-it-works.md), and [`README.md`](https://github.com/UditAkhourii/adhd/blob/main/README.md) for complete coverage
- All documentation is Markdown-based and viewable directly on GitHub or locally after cloning
- Source code in [`src/cli.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/cli.ts), [`src/engine.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/engine.ts), and [`src/render.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/render.ts) provides implementation details
- Agent integration instructions reside in [`skills/adhd/SKILL.md`](https://github.com/UditAkhourii/adhd/blob/main/skills/adhd/SKILL.md)

## Frequently Asked Questions

### Is there an external documentation website for UditAkhourii/adhd?

No. According to the repository structure, all documentation is maintained as Markdown files within the `documentation/` directory and viewable directly on GitHub. There is no separate documentation site or wiki; keeping docs in the repo ensures they remain synchronized with the codebase.

### How do I install the adhd-agent tool?

Installation instructions are located in [`documentation/install.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/install.md). The standard approach uses npm for global CLI access: `npm install -g adhd-agent`. You must also set your `ANTHROPIC_API_KEY` environment variable to authenticate with the underlying LLM provider.

### What is the difference between the README and the documentation folder?

The [`README.md`](https://github.com/UditAkhourii/adhd/blob/main/README.md) provides a high-level project overview, basic installation steps, and quick usage examples. The `documentation/` directory contains comprehensive guides including deep dives into architecture ([`how-it-works.md`](https://github.com/UditAkhourii/adhd/blob/main/how-it-works.md)), theoretical concepts ([`frames.md`](https://github.com/UditAkhourii/adhd/blob/main/frames.md), [`vs-cot-and-tot.md`](https://github.com/UditAkhourii/adhd/blob/main/vs-cot-and-tot.md)), and detailed API specifications ([`api.md`](https://github.com/UditAkhourii/adhd/blob/main/api.md)).

### Where can I find the TypeScript API specification?

The complete API reference including TypeScript interfaces and function signatures is documented in [`documentation/api.md`](https://github.com/UditAkhourii/adhd/blob/main/documentation/api.md). Implementation details for the main `run()` function and `renderText()` utility can be found in [`src/engine.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/engine.ts) and [`src/render.ts`](https://github.com/UditAkhourii/adhd/blob/main/src/render.ts) respectively.