Add notabene - #50
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe README adds ChangesNotabene tool listing
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
PierrunoYT
left a comment
There was a problem hiding this comment.
Thanks for the submission. The project qualifies, but the description currently makes successful agent execution sound automatic. Notabene provides the comment store, protocol, and agent integration; an arbitrary agent is not guaranteed to apply and resolve feedback correctly.
Suggested replacement:
notabene - Renders repository Markdown and MDX as a navigable documentation site with anchored comments, storing comments and journals in git-readable JSON alongside a protocol agents can follow to propose or apply source edits.
|
Thanks, agreed on the framing, the original wording overstated what happens automatically. I've taken your suggestion with one precision: notabene's agent protocol edits the documentation's Markdown source, not application code, so I changed the tail to "apply the corresponding edits to the Markdown source" to avoid that reading. |
Adds notabene to the tools list.
notabene renders a repo's Markdown/MDX as a navigable docs site where reviewers leave anchored, Google-Docs-style comments directly on the rendered text. The comments are committed as JSON alongside the docs, so a coding agent reads the open ones, applies the feedback as source edits, resolves the threads and writes a journal entry explaining what changed and why. The reviewer never has to verbalise the edit, and the whole round-trip stays in git.
Against the contributing guidelines:
**[Tool Name](link)** - Description.format@z29k/notabene; docs at https://z29k.github.io/notabene/Summary by CodeRabbit