Reference#
Every language has a complete API reference, generated from its own source on every change and hosted here. The page for each language is the way in: it lists every package with its install line, opens its API pages, and leads to the same capability in the other three languages.
| Language | Install | Reference |
|---|---|---|
| Rust | cargo add pamoja | Rust reference, every crate with its API pages, generated by rustdoc |
| TypeScript | npm install pamoja | TypeScript reference, every package with its API pages, generated by typedoc |
| Python | pip install pamoja | Python reference, every module with its API pages, generated by pdoc |
| C# | dotnet add package Pamoja | C# reference, every package with its API pages, generated by DocFX |
How they are made#
rustdoc documents the Rust crates from their doc comments, and the same documentation is
on docs.rs for each published version. typedoc reads the TypeScript facades, pdoc the
Python modules, and DocFX the .NET assemblies, each from this commit, so the four
references describe one version of the code. The reference pages and the tables in every
README come from one map, docs/capabilities.toml, which is checked against the crates,
the binding exports, and the .NET types on every change.
Every guide ends with the capability's API pages in each language and the row on that language's reference page, so the way from a worked example to the full API is one click.