z29k/notabene

<p align="center"> <img src="https://raw.githubusercontent.com/z29k/notabene/main/assets/notabene-logo.jpg" width="150" alt="notabene - logo" /> </p> <h1 align="center">notabene</h1> <p align="center"><em>nota bene</em> - the margin mark that means <strong>“note this well.”</strong></p> <p align="center"> <strong>Leave notes in the margins of your repo's docs - right on the rendered page -<br /> then let your AI agent apply them, resolve the threads, and journal <em>what changed &amp; why</em>.</strong> </p> <p align="center"> <a href="https://www.npmjs.com/package/@z29k/notabene"><img alt="npm" src="https://img.shields.io/npm/v/@z29k/notabene?logo=npm&amp;color=cb3837" /></a> <a href="https://github.com/z29k/notabene/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/z29k/notabene/actions/workflows/ci.yml/badge.svg" /></a> <img alt="Node ≥ 22.12" src="https://img.shields.io/node/v/@z29k/notabene?logo=node.js&amp;color=5FA04E" /> <a href="./LICENSE"><img alt="License: MIT" src="https://img.shields.io/npm/l/@z29k/notabene?color=3da638" /></a> </p> <p align="center"><strong>English</strong> · <a href="https://github.com/z29k/notabene/blob/main/README.fr.md">Français</a> · <a href="https://z29k.github.io/notabene/">📖 Documentation</a></p>

---

Iterate on your docs with an LLM - leave feedback anywhere, not squeezed into one prompt. A navigable doc site with multi-user comments, self-hosted in your git - no SaaS, no database. The anchored comment is the instruction: located, unambiguous, nothing to quote. Your agent reads it, edits the source, and journals what changed & why.

<p align="center"> <img src="https://raw.githubusercontent.com/z29k/notabene/main/assets/notabene-demo.gif" alt="notabene demo: comment a passage, the agent applies the edit, you approve the real diff" width="900" /> </p>

How it works (30 seconds)

1. npx notabene dev → open the site, select any text → leave a comment (or comment a whole p