Terminology & Documentation Updates

[ohdearquant]

7. Terminology & Documentation Updates

File: plans/07_terminology_documentation.md

Implementation Plan - Component 7: Terminology & Documentation Updates

Objective:
Remove or rename any “agent” references to preserve the pure session/branch model, and ensure all official docs reflect the new multi-branch approach.

---

Key Tasks

1. Codebase-Wide Terminology Sweep

   • Search for references to “Agent” or “agent.”
   • Replace with “Branch,” “BranchProfile,” or “Session/branch participant” as appropriate.

2. Update Code Comments & Docstrings

   • In branch.py, session.py, actions, tools modules, etc.
   • Clarify that each “participant” or “role” is just a specialized Branch.

3. Rework Documentation

   • docs/ folder:
     • Replace “agent” with “branch.”
     • Reposition “multi-agent” references to “multi-branch” or “multi-participant” as suits your brand identity.

4. Cookbook Overhaul

   • Where you had “Agent Recipes,” rename to “Branch Collaboration Recipes.”
   • Show examples of multi-branch usage flows in a single Session.

5. Deprecation Warnings (optional)

   • If you have public classes with “agent” in the name, add a short bridging period with deprecation warnings, then rename them in the next major release.

---

Implementation Steps

1. Global Find & Replace

   • Carefully rename classes, methods, doc references from AgentX to BranchX.
   • Make sure not to break public APIs if you maintain semver.

2. Docstring Overhaul

   • Focus on big items like “You are an agent => You are a branch participant.”
   • Also fix any confusion about “agent function calls” vs. “branch calls.”

3. Testing

   • Basic smoke tests ensure that new naming does not break any dynamic imports or references.

4. Docs

   • docs/*: comb through, remove “agent” language, re-center everything on branches.

---

End of plans/07_terminology_documentation.md