Skip to content

Update Readme#189

Merged
illeatmyhat merged 1 commit into
mainfrom
docs
Apr 16, 2026
Merged

Update Readme#189
illeatmyhat merged 1 commit into
mainfrom
docs

Conversation

@illeatmyhat

@illeatmyhat illeatmyhat commented Apr 16, 2026

Copy link
Copy Markdown
Collaborator

The github readme has been neglected for a bit
Closes #185

Summary by CodeRabbit

  • Documentation
    • Restructured Quick Start guide with separate paths for Lite and Evolve MCP Server setups
    • Expanded installation instructions with From Source (including frontend UI build) and From PyPI options
    • Clarified Lite Mode functionality and system architecture
    • Updated contributor documentation with explicit test execution tiers

@coderabbitai

coderabbitai Bot commented Apr 16, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 59e23773-a691-4cd2-990a-fb0338520419

📥 Commits

Reviewing files that changed from the base of the PR and between 9ca94e5 and 1d8d547.

⛔ Files ignored due to path filters (2)
  • docs/assets/architecture-wide-dark.svg is excluded by !**/*.svg
  • docs/assets/architecture-wide-light.svg is excluded by !**/*.svg
📒 Files selected for processing (3)
  • .secrets.baseline
  • CONTRIBUTING.md
  • README.md

📝 Walkthrough

Walkthrough

Documentation updates restructuring the README to emphasize value proposition and quick-start options (Lite vs Full server), reorganizing CONTRIBUTING.md section hierarchy with new testing guidelines, and updating secrets baseline metadata and scan results.

Changes

Cohort / File(s) Summary
Secrets Baseline
.secrets.baseline
Updated metadata timestamp (generated_at) and adjusted line_number for one existing hashed_secret in README.md from 53 to 58; all other scan result fields remain unchanged.
Contributing Guidelines
CONTRIBUTING.md
Reorganized section hierarchy by promoting subsections (### headings) to top-level headings (## headings) for bug reports, contribution types, development setup, coding style, components, secrets, and DCO. Added new "## Running Tests" section introducing five pytest execution tiers with markers for unit, platform_integrations, e2e, and llm tests, plus documentation link for end-to-end verification.
Project README
README.md
Restructured content to shift focus from architecture internals toward value proposition and quick-start options. Replaced feature bullets with new Proactive, Conflict Resolution, and On Command behavior descriptions. Added Quick Start (Lite) links to Claude Code and Codex, plus Quick Start (Evolve MCP Server) section. Expanded installation with "From Source" (frontend UI build steps) and "From PyPI" options. Shortened "Documentation" and "Development/Running Tests" sections, redirecting to CONTRIBUTING.md.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • visahak
  • gaodan-fang
  • vinodmut

Poem

🐰 A README blooms with clearer light,
From architecture clouds to value bright,
Quick-start paths both short and tall,
Tests that hop in tiers and all,
Users now see why Evolve's a friend! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@illeatmyhat illeatmyhat merged commit 9ba7cc9 into main Apr 16, 2026
5 of 6 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.

Improve README: lead with value proposition, add Evolve Lite quickstart

1 participant