documentation_guide

#Documentation Guide

This guide helps contributors understand where to document their work.

#Where things go

In-Code (Ruby): Use RDoc (# ...) for public API documentation and .rbs files in sig/ to define types.
- Examples: Method parameters, return types, class purposes, usage instructions, and simple code snippets.
In-Code (Rust): Use Rustdoc (/// ...) for information relevant only to Rust developers.
Repo Docs (doc/): Use Markdown in the main repository for information that is likely to change as the codebase changes.
- Examples: How to use the library, how to test your application, architecture and design docs.
Wiki: Use this Wiki for information about the project that is largely independent of the codebase.
- Examples: Process, roadmap, governance, real-world applications using the library, and archives of communication and decision-making.

#Key Links

commit 6184024f7eff68e8449742c202da5deb0f9b7ed5 Author: Kerrick Long <me@kerricklong.com> Date: 2026-01-26T21:04:08-06:00 docs: sync Chapter 2 (Rooibos) with beta API The documentation was out of date with the actual implementation. Updated the entry point from the test-only keyword-args API to the production fragment-based API. Updated the commands list to match what actually exists: removed Command.sequence, added cancel, all, open, and custom. Changed message format from arrays to Message:: objects. Replaced the verbose Rooibos.route/delegate example with the declarative Router DSL. Renamed Tea references to Rooibos throughout and updated version numbers in the roadmap. Generated with Antigravity (https://antigravity.google) Co-Authored-By: Claude Opus 4.5 (Thinking) <noreply@anthropic.com>