Skip to content

Update README with improved messaging and architecture documentation#63

Merged
Furisto merged 6 commits into
mainfrom
readme-arch
Nov 24, 2025
Merged

Update README with improved messaging and architecture documentation#63
Furisto merged 6 commits into
mainfrom
readme-arch

Conversation

@Furisto
Copy link
Copy Markdown
Owner

@Furisto Furisto commented Nov 24, 2025

• Value Prop: Changed focus from "transparency" to "self-hosted" and "programmatic control"
• Tool Calling: Added research citations supporting code-based tool calling
• Architecture: Added diagram showing daemon-client-server model with key components
• Setup: Simplified from 5 steps to 3, removed redundant configuration
• Examples: Updated agent names and simplified usage examples
• Roadmap: Reorganized into categories (Integration, Models, Capabilities, Security)

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Nov 24, 2025

Walkthrough

The README.md has been comprehensively updated to reflect architectural and messaging changes. The tagline now emphasizes "CodeMode tool calling" and "Self-hostable" instead of "Superior tool calling" and "Complete transparency." The documentation shifts focus toward daemon-based, client-server architecture with ConnectRPC API and programmatic access. Quick Start instructions now include installation options via Homebrew and pre-built binaries alongside build-from-source. The Architecture section introduces a Mermaid component diagram and redefines core components. Agent management sections are updated to reflect new agent lifecycle stages. The Roadmap is reorganized into categorized groups with focus on integration, model providers, agent capabilities, and security. Documentation references are expanded to include Architecture Documentation and User Guide.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 8e07138 and 2730a4c.

📒 Files selected for processing (1)
  • README.md (8 hunks)

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

Comment @coderabbitai help to get the list of available commands and usage tips.

@Furisto Furisto merged commit 24d70d4 into main Nov 24, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant