Skip to content

docs: align README with SDK hero, badges, and narrative#19

Merged
negillett merged 1 commit intoIntentProof:mainfrom
negillett:docs/readme-sdk-parity
May 10, 2026
Merged

docs: align README with SDK hero, badges, and narrative#19
negillett merged 1 commit intoIntentProof:mainfrom
negillett:docs/readme-sdk-parity

Conversation

@negillett
Copy link
Copy Markdown
Member

@negillett negillett commented May 10, 2026

Summary

  • Match SDK README structure: ## **Logs narrate; IntentProof gives you proof.** hero, badges directly under the hero (CI + conformance certificate), shared IntentProof / ExecutionEvent framing, full Why this matters (including Picture this), and an API-specific What this repository is section.
  • Rename QuickstartQuick start and align Requirements formatting with SDK style.

No code or workflow changes.

Test plan

  • Proofread rendered README on GitHub (hero, badge links, anchors).

Made with Cursor

Summary by CodeRabbit

  • Documentation
    • Added new branding statement and repositioned README narrative for clearer positioning.
    • Reorganized documentation structure to emphasize service value and ExecutionEvent contents upfront.
    • Updated Python version requirements and refined section formatting, including heading adjustments.

Review Change Stack

Match SDK opening (hero tagline, badges under hero, shared ExecutionEvent
and Why this matters sections), add API-specific positioning, and tighten
Requirements wording.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 10, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: deaa4208-aab3-4d7d-b5c8-a2face57c64d

📥 Commits

Reviewing files that changed from the base of the PR and between cae577c and 2a003dd.

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

📝 Walkthrough

Walkthrough

This PR updates README.md with a revised introduction emphasizing intent versus execution proof, enumerates ExecutionEvent structure, reorganizes narrative flow, and applies minor formatting refinements to the requirements section and headings.

Changes

README Branding and Documentation

Layer / File(s) Summary
Branding & Introduction Rewrite
README.md
Top-level intro replaced with branded positioning ("Logs narrate; IntentProof gives you proof"), ExecutionEvent field enumeration, "Why this matters" explanation, and repository/stacks introduction.
Documentation Polish
README.md
Requirements section wording refined for Python 3.12+ and Postgres version clarity; "Quickstart" heading renamed to "Quick start".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A README reinvented,
Proof of intent now presented,
Badges and fields now aligned,
Better words, better mind!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: reorganizing the README to align with SDK documentation style, including hero tagline, badges, and narrative structure.
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

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

@negillett negillett merged commit 34c8579 into IntentProof:main May 10, 2026
3 checks passed
@negillett negillett deleted the docs/readme-sdk-parity branch May 10, 2026 02:51
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