Skip to content

update README#48

Merged
erkangz merged 1 commit into
mainfrom
readme
Jun 12, 2026
Merged

update README#48
erkangz merged 1 commit into
mainfrom
readme

Conversation

@erkangz

@erkangz erkangz commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Restructured README with improved organization and navigation
    • Updated CLI examples with latest syntax and command flags
    • Added comprehensive guide to learning and knowledge management
    • Enhanced setup and configuration documentation
    • Clarified local data storage and network privacy

@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

This pull request comprehensively rewrites and reorganizes README.md to reflect the current product state. The documentation now centers on Ivan branding and introduces a clearer structure around "Why Ivan?", "Quick Start", "Expert Mode", and "Institutional Memory". Core examples and commands are updated to use the newer ivan "..." task invocation and --mode expert flag. The Institutional Memory section documents local learning workflows (init, ingest-query, query, coding sessions, hooks installation, rebuild). The PR comment handling flow now emphasizes GraphQL-based resolution tracking with updated CLI flags. GitHub Actions configuration, Drivers, and CLI Reference sections are modernized with updated model names, per-run configuration, and expandable details blocks. Architecture and How It Works sections replace prior diagrams with current module/component listings and web UI tracking details. Supporting sections (Contributing, Security, Limitations, License) are condensed and the closing CTA is refreshed.

Poem

🐰 A thousand words were rearranged,
New branding shines, the docs estranged,
From old to new, the flow grows clear—
Quick Start whispers, Expert mode near!
Memory learns, loops gently close,
The README blooms in freshest prose. 🌱

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'update README' is vague and generic, providing no meaningful information about what specifically changed in the README or why. Replace with a more descriptive title that highlights the main change, such as 'Reorganize README with Ivan branding and Institutional Memory section' or 'Update README with new CLI examples and documentation structure'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

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

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

@erkangz erkangz merged commit 7d120fe into main Jun 12, 2026
2 of 3 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.

2 participants