Skip to content

docs(readme): align with v2.0.0 changes and fix issues - #56

Merged
jeremylongshore merged 1 commit into
mainfrom
fix/readme-alignment
Jan 6, 2026
Merged

docs(readme): align with v2.0.0 changes and fix issues#56
jeremylongshore merged 1 commit into
mainfrom
fix/readme-alignment

Conversation

@jeremylongshore

Copy link
Copy Markdown
Owner

Summary

Fixes README issues that were out of sync with recent changes:

  • Remove Co-Authored-By from commit example - This causes CLA failures with external projects (we just hit this with Google Cloud)
  • Update repo URLs - Changed from jeremylongshore/bobs-brain to intent-solutions-io/bobs-brain
  • Update test counts - 303 → 370+ (actual current count)
  • Add MCP server - Added to directory structure and capabilities list
  • Add mission_spec and iam_ agents* - Added to directory structure
  • Update version examples - 0.10.0 → 2.0.0

Test plan

  • Verified all links point to correct repo
  • Verified test count matches pytest output

🤖 Generated with Claude Code

- Remove Co-Authored-By from commit example (causes CLA failures)
- Update repo URLs from jeremylongshore to intent-solutions-io
- Update test counts from 303 to 370+
- Add MCP server to directory structure and capabilities
- Add mission_spec and iam_* agents to directory structure
- Update environment example versions to 2.0.0
- Update test coverage section with new test areas

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello @jeremylongshore, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on synchronizing the README.md file with the latest changes and developments in the project. It addresses several inconsistencies, ensuring that the documentation accurately reflects the current state of the repository, its components, and operational guidelines. The primary goal is to provide up-to-date and correct information for users and contributors.

Highlights

  • Commit Example Update: Removed the 'Co-Authored-By' line from the commit example to prevent CLA failures with external projects.
  • Repository URL Migration: Updated all repository URLs in the README from 'jeremylongshore/bobs-brain' to 'intent-solutions-io/bobs-brain'.
  • Test Count Alignment: Adjusted the reported test count from 303 to 370+ to reflect the current actual number of unit tests.
  • New Component Documentation: Added the MCP server, 'mission_spec', and 'iam_*' agents to the directory structure and capabilities list.
  • Version Example Synchronization: Updated version examples in the environment variables section from '0.10.0' to '2.0.0' and 'latest' to align with recent releases.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README.md to align with the v2.0.0 release, including updating repository URLs, test counts, and adding information about new features like the MCP server and Mission Spec. The changes are well-aligned with the PR's goals. I've provided a couple of suggestions to further improve the documentation's clarity and completeness, specifically regarding the project's directory structure visualization and the contribution guide.

Comment thread README.md
Comment on lines +203 to 209
│ ├── iam_*/ # 8 specialist agents
│ └── mission_spec/ # Declarative workflow compiler
├── mcp/ # MCP Server (Universal Tool Access)
│ └── src/ # FastAPI server with 8 tools
├── service/ # HTTP gateways (proxies only!)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The vertical lines on lines 205 and 208 incorrectly imply that mcp/ and service/ are subdirectories of agents/. To accurately represent the root-level directory structure, these connector lines should be removed. This was also an issue in the previous version of the file.

Suggested change
│ ├── iam_*/ # 8 specialist agents
│ └── mission_spec/ # Declarative workflow compiler
├── mcp/ # MCP Server (Universal Tool Access)
│ └── src/ # FastAPI server with 8 tools
├── service/ # HTTP gateways (proxies only!)
│ ├── iam_*/ # 8 specialist agents
│ └── mission_spec/ # Declarative workflow compiler
├── mcp/ # MCP Server (Universal Tool Access)
│ └── src/ # FastAPI server with 8 tools
├── service/ # HTTP gateways (proxies only!)

Comment thread README.md
Comment on lines 1081 to 1083
cd bobs-brain

# Set up environment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The contribution guide is missing instructions for setting up an upstream remote. This is a crucial step for contributors to keep their forks updated with the main repository and avoid merge conflicts. It's best practice to include this in the setup instructions.

Suggested change
cd bobs-brain
# Set up environment
cd bobs-brain
# Add upstream remote to keep your fork updated
git remote add upstream https://github.com/intent-solutions-io/bobs-brain.git
# Set up environment

@jeremylongshore
jeremylongshore merged commit 02bbbfc into main Jan 6, 2026
14 checks passed
@jeremylongshore
jeremylongshore deleted the fix/readme-alignment branch January 6, 2026 03:25
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