# How Is the Documentation for denoland/celld Organized?

> Understand the celld documentation structure. Discover the two-tier hierarchy with README.md for overviews and the docs directory for detailed guides.

- Repository: [Deno/celld](https://github.com/denoland/celld)
- Tags: documentation-overview
- Published: 2026-09-05

---

**The celld documentation is organized as a two-tier hierarchy: a top-level [`README.md`](https://github.com/denoland/celld/blob/main/README.md) for project overview and quick-start, and a dedicated `docs/` directory containing focused markdown files for each functional area.**

The **celld** repository by Deno follows a modular, file-based documentation structure that prioritizes discoverability and maintainability. Rather than a single monolithic guide, the documentation is split into discrete files covering specific topics, making it easy for users and contributors to locate exactly what they need.

## Top-Level Documentation Entry Point

The repository root contains a single **[`README.md`](https://github.com/denoland/celld/blob/main/README.md)** file that serves as the primary landing page. This file provides:

- High-level project overview
- Quick-start instructions
- Links to all detailed documentation in the `docs/` directory

According to the denoland/celld source code, this README acts as the navigation hub, directing readers to deeper content without overwhelming them with detail upfront.

## The `docs/` Directory Structure

All detailed documentation lives under the **`docs/`** directory. Each file addresses one specific aspect of the system, maintaining a clean separation of concerns:

| File | Primary Focus |
|------|-------------|
| [[`docs/README.md`](https://github.com/denoland/celld/blob/main/docs/README.md)](https://github.com/denoland/celld/blob/main/docs/README.md) | High-level description of celld's goals and core concepts |
| [[`docs/library-api.md`](https://github.com/denoland/celld/blob/main/docs/library-api.md)](https://github.com/denoland/celld/blob/main/docs/library-api.md) | Public Rust API reference exported by the crate |
| [[`docs/guarantees.md`](https://github.com/denoland/celld/blob/main/docs/guarantees.md)](https://github.com/denoland/celld/blob/main/docs/guarantees.md) | Formal consistency, durability, and ordering guarantees |
| [[`docs/testing.md`](https://github.com/denoland/celld/blob/main/docs/testing.md)](https://github.com/denoland/celld/blob/main/docs/testing.md) | Testing strategies and utilities for celld components |
| [[`docs/telemetry.md`](https://github.com/denoland/celld/blob/main/docs/telemetry.md)](https://github.com/denoland/celld/blob/main/docs/telemetry.md) | Built-in telemetry and metrics collection |
| [[`docs/security.md`](https://github.com/denoland/celld/blob/main/docs/security.md)](https://github.com/denoland/celld/blob/main/docs/security.md) | Security model, threat considerations, and best practices |
| [[`docs/limitations.md`](https://github.com/denoland/celld/blob/main/docs/limitations.md)](https://github.com/denoland/celld/blob/main/docs/limitations.md) | Known limits, edge-case behavior, and open issues |
| [[`docs/wasm.md`](https://github.com/denoland/celld/blob/main/docs/wasm.md)](https://github.com/denoland/celld/blob/main/docs/wasm.md) | WebAssembly compilation and browser usage |
| [[`docs/cloudflare-compat.md`](https://github.com/denoland/celld/blob/main/docs/cloudflare-compat.md)](https://github.com/denoland/celld/blob/main/docs/cloudflare-compat.md) | Running celld on Cloudflare Workers and related constraints |

## Design Philosophy Behind the Documentation Organization

The celld documentation structure reflects several intentional design choices:

- **Single-responsibility files** — Each markdown file covers exactly one topic, preventing information overload
- **Direct GitHub accessibility** — All files render natively in the GitHub UI without additional tooling
- **Linkable deep references** — Specific sections can be referenced directly via permalinks
- **Contributor-friendly** — Small, focused files reduce merge conflicts and simplify reviews

## Accessing Documentation Programmatically

You can reference celld documentation URLs directly in your tooling:

```rust
/// Returns the URL to the library API reference.
fn api_docs_url() -> &'static str {
    "https://github.com/denoland/celld/blob/main/docs/library-api.md"
}

```

```bash

# Open security documentation from the command line

xdg-open https://github.com/denoland/celld/blob/main/docs/security.md

```

## Summary

- The **[`README.md`](https://github.com/denoland/celld/blob/main/README.md)** at the repository root provides overview and navigation
- The **`docs/`** directory contains nine focused markdown files covering distinct functional areas
- **File-based organization** enables quick location of specific topics without searching through monolithic guides
- **Direct GitHub rendering** eliminates the need for external documentation sites
- All documentation paths follow predictable patterns: `docs/{topic}.md`

## Frequently Asked Questions

### Where is the main entry point for celld documentation?

The main entry point is the **[`README.md`](https://github.com/denoland/celld/blob/main/README.md)** file in the repository root. It contains project overview, quick-start instructions, and links to all detailed documentation files under the `docs/` directory.

### How do I find the Rust API reference for celld?

The Rust API reference is located at **[`docs/library-api.md`](https://github.com/denoland/celld/blob/main/docs/library-api.md)**. This file documents the public API exported by the crate, including type signatures, traits, and module structure.

### Is there documentation for running celld on Cloudflare Workers?

Yes. The **[`docs/cloudflare-compat.md`](https://github.com/denoland/celld/blob/main/docs/cloudflare-compat.md)** file specifically covers Cloudflare Workers compatibility, including deployment steps, environment constraints, and known limitations for that platform.

### Where are celld's formal guarantees documented?

Formal guarantees about consistency, durability, and ordering are documented in **[`docs/guarantees.md`](https://github.com/denoland/celld/blob/main/docs/guarantees.md)**. This file establishes the behavioral contracts users can rely on when building with celld.