From e2d3a551e8d022fdc22ff09a6ae56de6ed8a2af0 Mon Sep 17 00:00:00 2001 From: Steve Brown Date: Sun, 25 Oct 2026 18:17:38 -0400 Subject: [PATCH] docs: explain stack capabilities and tool choices by use case --- README.md | 21 ++++ docs/book/src/SUMMARY.md | 1 + docs/book/src/introduction.md | 4 + docs/book/src/personas.md | 116 +++++++++++++++++++++++ docs/book/src/profiles.md | 8 +- docs/book/src/stack.md | 3 + docs/knowledge/repository-knowledge.json | 4 +- 7 files changed, 153 insertions(+), 4 deletions(-) create mode 100644 docs/book/src/personas.md diff --git a/README.md b/README.md index aa736ba..4d8aa59 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,27 @@ work. Give an agent durable memory and code context, without assembling every to by hand. Tambo is a CLI and [agent skill](skills/tambo/SKILL.md). The compatibility command `caboodle` remains available. +## What you can do with the toolkit + +Choose the parts that solve your problem; you do not need every tool. + +- **Keep knowledge you can explain:** Quipu stores facts, provenance and history; + Camayoc checks incoming knowledge, using shared vocabulary and shapes from Quechua. + Write enforcement depends on your configured rules. +- **Give a coding assistant useful context:** Bobbin searches your code and supplies + context; Yupana follows code structure and can check actions against policy. +- **Track work across people and agents:** Seeds keeps work items in Quipu; + Shantytown runs agent crews against that work. +- **Connect events to action:** Chaski delivers reactions and notifications, Shuttle + records signed workflow transitions, and Rikuy presents a live brief. +- **Learn from failed tool calls:** Desire Path collects failures into signposts and + feature requests, and can also run on its own. + +Tambo composes a reviewable installation plan and verifies the selected tools. +Installing them does not automatically connect every workflow or enable every +policy. [Choose tools for your use case](https://intigraph.github.io/tambo/personas.html), +then [choose an installation profile](https://intigraph.github.io/tambo/profiles.html). + ## Install ```bash diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index ecd5c68..e5ed7c5 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -2,6 +2,7 @@ [The quipu stack](introduction.md) +- [Choose tools for your use case](personas.md) - [Getting started](getting-started.md) - [Installing and removing](installing.md) - [Installation and agent reference](installation-reference.md) diff --git a/docs/book/src/introduction.md b/docs/book/src/introduction.md index 00ea631..a6f6d4b 100644 --- a/docs/book/src/introduction.md +++ b/docs/book/src/introduction.md @@ -21,6 +21,10 @@ for the settings and their defaults. ![The quipu stack loop: agents send activity to Camayoc, which sends tagged, quarantined episodes to Quipu. Quipu supplies knowledge to Bobbin, which feeds the next agent turn. Yupana enforces code policies and contributes committed structure to Quipu and code context to Bobbin. Desire Path turns hallucinations into feature requests. Seeds tracks work items in the Quipu knowledge base. Tambo installs, proves, and observes the tools.](images/stack-loop.svg) +Choose a starting set in [tools for your use case](personas.md). The guide maps +developers, crew leads, knowledge curators, service operators and individual +planners to the parts they need. + ## Three ways in ### 1. Try it in your browser diff --git a/docs/book/src/personas.md b/docs/book/src/personas.md new file mode 100644 index 0000000..7248581 --- /dev/null +++ b/docs/book/src/personas.md @@ -0,0 +1,116 @@ +# Choose tools for your use case + +Start with a problem, then add tools when you need them. These are suggested +workflows, not additional Tambo profiles or a promise that every connection is +configured for you. Tambo installs and verifies a selected set; indexing, +agent registration, event sources and policies still need their own setup. + +## A developer working with a coding assistant + +**Goal:** find the right code and carry useful context between tasks. + +**Start with:** Tambo's `retrieval` profile: Quipu for durable knowledge, +Camayoc for checked knowledge ingress and Bobbin for code search/context. +`tambo quickstart` is the local, single-user route. Index the repository you +want to work on and register its server as described in the agent guide. + +**Example workflow:** search for the code behind a behavior, make a change, +then preserve its rationale and source as knowledge for the next task. + +**Add when needed:** Yupana through `code-intel` for callers and change impact; +Desire Path to capture failed tool calls rather than repeating them. Policy +checking needs configured policies; an index alone is not enforcement. + +Next: [getting started](getting-started.md), [using agents](agents.md), +[profiles](profiles.md). + +## An engineering team or agent-crew lead + +**Goal:** keep ownership, progress and handoffs visible across several workers. + +**Start with:** Seeds for work items and Shantytown for a host-based agent crew. +The `crew` profile includes the knowledge/retrieval tools and the Chaski, +Seeds and Shuttle members. Choose the runtime explicitly, for example +`tambo plan --profile crew --crew shantytown`, then review the plan before apply. + +**Example workflow:** assign a tracked task, let an agent work on it, record the +result with provenance and use a signed workflow for a handoff that needs an +explicit transition. Configure Chaski reactions for the events you want delivered. + +**Add when needed:** Rikuy for a shared live brief; Yupana for code-policy and +impact checks. A live brief needs its data sources, and notifications need +configured subscriptions. Neither follows automatically from installing tools. +The optional `creel`, `both` and `standalone` runtime choices are described in +profiles; `both` retains explicit handoff rather than automatic fan-out. + +Next: [profiles](profiles.md), [crew contracts](crew-contracts.md), +[the stack](stack.md). + +## A knowledge curator or researcher + +**Goal:** retain evidence and vocabulary so a claim can be traced and revisited. + +**Start with:** the `kg` profile, Quipu plus Camayoc. Quipu keeps provenance and +history; Camayoc prepares and checks ingress. Quechua supplies the shared +vocabulary and shapes that help tools agree on the meaning of facts. + +**Example workflow:** prepare a source-backed episode, validate its terms and +provenance, admit it through the configured gate, then query the recorded facts +and their history. Choose the write rules you need rather than assuming every +installation refuses the same inputs. + +**Add when needed:** reviewed corpus shares, or Chaski to notify you when relevant +knowledge changes. Shares are staged imports; Tambo does not automatically promote +them into ROOT. Repository-pendant availability is a separate publication gate. + +Next: [the corpus](corpus.md), [profiles](profiles.md), +[Quipu's book](https://intigraph.github.io/quipu/). + +## A platform or service operator + +**Goal:** connect service changes, delivery records and operational decisions. + +**Start with:** Quipu and Camayoc for source-backed operational knowledge and +delivery ingress. Tambo supplies a reviewable plan and verification; start small +with `kg` and review additional members as your workflow grows. + +**Example workflow:** configure a supported delivery emitter, record a deployment +outcome, query its change history and use that evidence in an operational decision. + +**Add when needed:** Chaski for event-driven notifications, Shuttle for signed +runbooks and Rikuy for status and decisions in a live brief. Configure each event +source, subscription and view explicitly. Tambo does not enable deployment +emitters or prove DORA coverage; missing history is not a measured zero. + +The `everything` profile is a broader tool selection, not an all-services +production deployment. Check the generated plan and each tool's proof boundary. + +Next: [the stack and its proofs](stack.md), [profiles](profiles.md), +[Camayoc's delivery catalog](https://github.com/intigraph/camayoc/blob/main/catalog/README.md). + +## An individual organizing projects and decisions + +**Goal:** keep tasks and the reasons behind decisions together. + +**Start with:** Quipu and Camayoc for durable notes with provenance; add Seeds +when the work needs tracked items. A `crew` plan with `--crew standalone` makes +the tools available without installing a crew runtime. + +**Example workflow:** record a decision and its source, create the related work +item, then update its state as the work progresses. Query the evidence again +when you revisit the decision. + +**Add when needed:** Chaski for configured reminders or notifications, and Rikuy +for a live brief. This is a knowledge-and-work workflow, not a built-in calendar +or personal-planning profile. No agent crew is required. + +Next: [profiles](profiles.md), [using Tambo](using.md), [the stack](stack.md). + +## Turn a recommendation into an installation + +The available profile names are `kg`, `retrieval`, `code-intel`, `crew` and +`everything`. The canonical [stack table](stack.md#related-projects) describes +the twelve projects; it is not an install manifest. In particular, `everything` +does not mean all twelve projects are installed. Inspect the plan's actual +members, review [compatibility](compatibility.md), and retain the plan and +state paths so you can resume or verify the same installation. diff --git a/docs/book/src/profiles.md b/docs/book/src/profiles.md index 231fb0b..3365ed3 100644 --- a/docs/book/src/profiles.md +++ b/docs/book/src/profiles.md @@ -1,5 +1,8 @@ # Profiles +Start with [tools for your use case](personas.md) if you are choosing by goal. +Those recommendations are not additional profile names. + - `kg` — quipu + camayoc - `retrieval` — + bobbin - `code-intel` — retrieval + Yupana; isolated `analyze`/`callers` proof @@ -10,8 +13,9 @@ Both harnesses are first-class: **Claude Code and codex** can each drive the install, and when a crew is chosen the wizard asks which harness each role runs on, emitting the right per-harness configuration. The `crew` profile also -installs seeds (`sd`), the crew's work tracker, and shuttle, its workflow engine. -- `everything` — code-intel + Desire Path + seeds + shuttle; isolated +installs Chaski for reactions and notifications, seeds (`sd`) for work tracking, +and shuttle for signed workflows. +- `everything` — code-intel + Desire Path + Chaski + seeds + shuttle; isolated failure-ingest/read proof, a seeds marker round trip, and a shuttle run round trip diff --git a/docs/book/src/stack.md b/docs/book/src/stack.md index b775c51..93cd9f9 100644 --- a/docs/book/src/stack.md +++ b/docs/book/src/stack.md @@ -32,6 +32,9 @@ box's first knowledge is a record of the box itself. The agent-facing version of this workflow is the [`tambo` skill](https://github.com/intigraph/tambo/blob/main/skills/tambo/SKILL.md), and the full design is in the [book](introduction.md). +For concrete starting points, see [tools for your use case](personas.md). +The table below is the shared project roster, not a list installed by every profile. + ## Related projects {{#include ../../stack-table.md:table}} diff --git a/docs/knowledge/repository-knowledge.json b/docs/knowledge/repository-knowledge.json index d25db1b..aa5988a 100644 --- a/docs/knowledge/repository-knowledge.json +++ b/docs/knowledge/repository-knowledge.json @@ -8,7 +8,7 @@ "source": "README.md", "subject": "http://aegis.gastown.local/ontology/doc/tambo/README.md", "summary": "Tambo installs and verifies the knowledge-tool stack from a reviewable plan. The transition retains the caboodle command and existing plan/state paths; publication and installed verification remain separate.", - "source_sha256": "214401168289a1fd66834eb48b7b6c7d81178333426db7af5302d6e7346f8017", + "source_sha256": "0fb7b5ae7383afcf739e879abfa7327b477f2206a2fd1662541b44c90965c3d6", "type": "Concept" }, { @@ -72,7 +72,7 @@ "source": "README.md", "subject": "http://aegis.gastown.local/ontology/doc/tambo/README.md", "summary": "Start with the local single-user quickstart and its verified-tool success checks before selecting remote service mode.", - "source_sha256": "214401168289a1fd66834eb48b7b6c7d81178333426db7af5302d6e7346f8017", + "source_sha256": "0fb7b5ae7383afcf739e879abfa7327b477f2206a2fd1662541b44c90965c3d6", "properties": { "startHereOrder": 1, "glossaryTerm": "https://scbrown.github.io/quechua/ns#Tool"