docs(readme): redesign for better traction and narrative clarity#559
Conversation
KaifAhmad1
commented
May 18, 2026
KaifAhmad1
commented
- Reorder sections: Problem → Solution → Quick Start → What's New → Integrations
- Add website and docs badges to the top badge strip
- Improve hero tagline and narrative blockquote
- Restore v0.4.0 (Temporal, SKOS, SHACL) and v0.3.0 release sections
- Remove duplicate modules list; consolidate into single table
- Fix broken emoji characters in Enterprise section
- Add blank lines around all headings and list blocks
- Reorder sections: Problem → Solution → Quick Start → What's New → Integrations - Add website and docs badges to the top badge strip - Improve hero tagline and narrative blockquote - Restore v0.4.0 (Temporal, SKOS, SHACL) and v0.3.0 release sections - Remove duplicate modules list; consolidate into single table - Fix broken emoji characters in Enterprise section - Add blank lines around all headings and list blocks
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 731e7415d4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ) | ||
| context.checkpoint("before_merge") | ||
| # ... make changes ... | ||
| diff = context.diff_checkpoints("before_merge", "after_merge") |
There was a problem hiding this comment.
This example calls diff_checkpoints("before_merge", "after_merge") without ever creating the after_merge checkpoint, so users copying it will immediately hit KeyError: Unknown checkpoint label(s): after_merge instead of seeing a diff. AgentContext.diff_checkpoints requires both labels to exist, so the snippet should create context.checkpoint("after_merge") (after making changes) before diffing.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f17deda7f7
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| rate_id = graph.record_decision( | ||
| category="interest_rate", | ||
| scenario="Set rate for approved mortgage", | ||
| outcome="rate_set_6.2pct", | ||
| confidence=0.98, |
There was a problem hiding this comment.
ContextGraph.record_decision requires a non-empty reasoning parameter, but the second graph.record_decision(...) call omits it here, so the Quick Start snippet raises a TypeError as soon as users run it. Because this is the first runnable example in the README, it blocks onboarding and should include reasoning= (as the previous version did).
Useful? React with 👍 / 👎.
1 participant
