Skip to content

Add notabene - #50

Open
wamxx wants to merge 2 commits into
PierrunoYT:masterfrom
wamxx:add-notabene
Open

Add notabene#50
wamxx wants to merge 2 commits into
PierrunoYT:masterfrom
wamxx:add-notabene

Conversation

@wamxx

@wamxx wamxx commented Aug 1, 2026

Copy link
Copy Markdown

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:

  • Developer-workflow tool (documentation review, agent-applied edits) — not a generic AI product
  • Inserted in alphabetical order, between Northflank and Nova
  • Uses the existing **[Tool Name](link)** - Description. format
  • Neutral, concrete description; no promotional language
  • Public repository link; MIT; published on npm as @z29k/notabene; docs at https://z29k.github.io/notabene/
  • Checked for duplicates — not currently listed

Summary by CodeRabbit

  • Documentation
    • Added the Notabene AI development tool to the tools list, including its repository link and description.

@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: b7786559-d888-45a5-88d9-1a64821ab89f

📥 Commits

Reviewing files that changed from the base of the PR and between 16d1a8a and e8094a2.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

The README adds notabene to the alphabetically organized AI development tools list. The entry includes its repository link and describes Markdown/MDX rendering, anchored comments, and agent-driven feedback application.

Changes

Notabene tool listing

Layer / File(s) Summary
Add notabene entry
README.md
The tools list adds notabene with its repository link and feature description.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 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 clearly and concisely identifies the main change: adding notabene to the tools list.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@PierrunoYT PierrunoYT left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@coderabbitai coderabbitai Bot mentioned this pull request Aug 3, 2026
@wamxx

wamxx commented Aug 3, 2026

Copy link
Copy Markdown
Author

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.

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