Docs
The documents that ship with grooph, rendered for reading. Each page is a file in the repository, linked at its foot.
Start
- QuickstartOpen the app and draw, start from a template, install the command line, or ask an agent to draw for you.
- Drawing with an agentFor an agent, or a person working with one: when a diagram is needed, the shortest path to one, the tools, and what works in a chat app.
- The agents' referenceWhat an agent looks things up in: the smallest document worth drawing, every operation by example, and what to do about each rule.
Reference
- The graph documentThe graph document: its fields, what they mean, and the rules it must follow.
- Operation mapsThe second kind of document, for work that spans sessions, people, and accounts.
- TemplatesTemplates, registries, and the pattern library, and how to use or save one.
- Proposal sets and share linksProposal sets, share links, and the compare view: how an agent offers a few diagrams and a person picks one.
- Pictures, views, and sharingPictures, the outline, the offline page, embeds, the 3D views, and the six themes.
- Rule referenceEvery rule by its stable code, with a document that fires it and one that does not.
- The CLI, command by commandThe command line, command by command, each with the help it prints itself.
Examples
Experimental
- Watching a session (experimental)Watching a session: the hook that records which subagents start and stop, and the live view that draws them.
- The lab (experimental)The lab: compiling a diagram into a prompt package, run folders, and the comparison runners, kept in the repository and out of the package.
- What the experiments foundWhat the experiments found: the paired comparisons of a compiled diagram against a plain prompt, the check that watching does not interfere, and what each cost.
Project
- PrivacyNo account, no server, no cookies, no analytics: where a diagram lives and what leaves your device.
- SecurityWhat grooph does with a document someone else made: link limits, size caps, escaping, the offline page, and embeds.
- How grooph is builtHow grooph is built: one pure core and the app, the command line, and the MCP server around it, and why it draws and does not direct.
- ContributingHow to send a diagram, a fix, or a rule, and what a pull request is held to.
- ReleasesEach version, its date, and what changed for a person using it.