Skip to content
Back to the portfolio

InDocs: Agent-Operated Documentation

  • React
  • TypeScript
  • Convex
  • Keycloak
  • Markdown
  • Claude Code

My role

I built the back end, the front end and the terminal skill on my own; QA was the only outside step.

InBot's documentation used to live in markdown files in a repository: only people comfortable with git could write, and there were no drafts and no record of who changed what. InDocs moves that content into Convex and opens writing to every team, without losing control over what goes live.

Two areas: open public documentation and an internal area behind company login.
Web editor: markdown with side-by-side preview, tags, images and reorderable sections.
Drafts and selective publishing: pages start as drafts, and "Publish changes" picks what goes live; the site only serves the published snapshot.
API explorer: every endpoint with parameters, expected response and ready-to-run sample code.
Audit trail: every action records the author, time and the content before and after.
Agent-operated: the /indocs skill answers questions by checking tags first, creates and edits docs always as drafts, publishes only after confirmation, tells who changed each page and turns a bot journey export into documentation.

Internal InBot system: the code is proprietary. The public area is live at docs.inbot.com.br; screenshots of the internal area use fictitious content.

Before

Docs as markdown files in git: fixing a comma required a PR, non-developers couldn't write, and whatever was on the branch went live, ready or not.

The problem

The documentation was a set of markdown files versioned in git. Fixing a typo meant opening a PR, non-developers didn't write, and whatever was on the branch went live, ready or not.

There was also no way to tell who changed a page and when without digging through commits.

The solution

I migrated the content to Convex, with sections, pages, tags and images, and built a web editor behind company login, with edit permission read live from the role in the token. Each page keeps its draft and, separately, a snapshot of what is live; the site build only serves that snapshot, so editing doesn't change the site until someone publishes.

Every mutation writes an audit entry with the before and after. On top of that I built the /indocs skill, which does the same from the terminal: it searches, writes drafts and publishes after confirmation.

Decisions and trade-offs

Drafts kept apart from the published snapshot: editing doesn't change the site until someone publishes. Every mutation is audited with before and after. The same operations are available from the terminal through the /indocs skill, for people who prefer to ask Claude Code.

The results

Teams that don't use git now write documentation directly in the browser or by talking to Claude Code. Publishing became an explicit decision with an author and content history, and the public documentation stays live at docs.inbot.com.br.

Results by the numbers

  • 304agent lookups in the docs through the skill
  • /indocsRun by an agent
  • 37Commits
  • 35Test files
  • Pública + internaAreas