Documentation
Red Pen Documentation
A free, local-first review-notes layer for everywhere you build (WordPress, Node/Express, any website, Blender, and Ableton Live), plus the Red Pen Hub, a single board that aggregates notes across every project.
What Red Pen is
Red Pen is a developer tool for leaving review notes on the thing itself. Instead of a separate tracker full of "the button near the header is misaligned", you pin a typed note directly to that button, on the page where it lives. Every note carries a type, a priority and a status, and collects into a per-project repository. Replies and screenshots exist on some surfaces and not others; the Surface matrix is the per-feature answer.
It is the same idea and the same note model on five surfaces, so you learn it once and use it everywhere. They are not identical: each is at its own maturity level, and the Surface matrix is the per-feature answer. A companion piece, the Hub, rolls every project's notes into one board.
The principles
- Free and open, forever. Everything that ships is free wherever it ships, across every surface and the Hub. You never make an account or paste a key, and nothing expires. The surfaces are at different maturity levels, so "free everywhere" has never meant "identical everywhere": the Surface matrix says which surface has what, and where it shows a gap the feature is unbuilt rather than paywalled. If it saves you time, you can back the next release; support is optional and never gates a feature.
- Local-first, no phone-home. Your notes live in your site's database, a local file, or your browser. There is no service on the other end, so nothing is measured and nothing can be switched off remotely. Nothing leaves your machine unless you send it somewhere yourself.
- Dev-only by default. Red Pen is a tool for the people building the site, not its visitors. WordPress checks a capability, Express checks NODE_ENV and the connection's remote address, Blender and Ableton only run inside your own session. The drop-in script is the exception: it is a bare script tag, so the guard is yours to write and its page says how.
- One model, many surfaces. A note is a note whether it was left in WordPress, an Express app, a static page, a Blender scene, or Ableton. The shared model is what lets the Hub aggregate them.
The surfaces at a glance
The plugin stable
A logged-in Dev Mode overlay on the front end plus a full notes repository in wp-admin. The flagship, and the most complete surface.
NodeExpress middleware v0.3.1
One line, app.use(redPen()), injects the overlay and a tiny notes API. Notes persist to .redpen/notes.jsonl, an append-only log you commit.
Static drop-in v0.1.1
A single script tag for static sites, SPAs, anything. No hosting and no build step. Notes live in the browser; export and import as JSON.
Ableton LiveLive extension v0.9.5, awaiting SDK release
Notes on clips, tracks, scenes, and devices, mirrored as locators and clip tints, synced with the Hub. Feature-complete; ships when the Live SDK leaves beta.
Blender add-on v0.4.0
A bug tracker for your scene: typed notes in the viewport sidebar, saved next to the .blend, pushed and pulled to the Hub.
The HubRed Pen Hub v0.9.1
A standalone local board that aggregates notes from every project and surface into one screen, with two-way resolve/reopen. Free and open, with no limit on how many projects you connect.
Core concepts
The note model, types, priorities, statuses, anchors, replies, and the dev-only and local-first guarantees that every surface shares.
SharedSurface matrix
Which surface has what, feature by feature, read out of the shipping code. Where a feature is missing from a surface, the cell says why.
ContributeBuild a surface
Bring the software you actually use into the ecosystem: the note model to implement, the two ways to connect to the Hub, and the conventions every surface follows.
Which one do I install?
| If you are working on... | Use | Notes stored in |
|---|---|---|
| A WordPress site | The WordPress plugin | The site database (a custom post type) |
| A Node / Express (or Connect) app | The Express middleware | .redpen/notes.jsonl in the app |
| Any other website (static, an SPA build, a page on disk) | The static drop-in | The browser's localStorage |
| A track in Ableton Live | The Live extension | An external notes.json file |
| A Blender scene | The Blender add-on | .redpen/notes.json next to the .blend |
| Several projects at once, on one board | The Hub | Reads the others; never your only copy |
Current versions
This documentation set describes these releases. See each surface's page for its full changelog and the Roadmap for what is planned next.
| Surface | Version | Status |
|---|---|---|
| WordPress plugin | 0.26.0 | Stable |
| Express middleware | 0.3.1 | Active development |
| Static drop-in | 0.1.1 | Active development |
| Ableton Live extension | 0.9.5 | Feature-complete, awaiting the Live SDK's public release |
| Blender add-on | 0.4.0 | Active development |
| Red Pen Hub | 0.9.1 | Active development |