docs-agent

Generate Confluence-ready documentation from any codebase — as GitHub Copilot slash commands.

docs-agent is a lightweight Copilot plugin that turns your code, git changes, and tickets into clean documentation you can paste straight into Confluence Cloud and get native rendering — no Confluence API, no manual reformatting.

It runs in GitHub Copilot CLI and VS Code + GitHub Copilot.

---

Commands

Command	What it does
/onboarding	Explores the whole project and writes a new-joiner onboarding guide. Run once per repo.
/documentate	Documents the feature you just built — pulls ticket context, analyzes your git diff, and lists affected components.
/explain-this <path>	Deep-dives one file/feature: purpose, internals, dependencies, data flow, gotchas.
/update-documentation <doc>	Updates an existing doc after behavior changes, with a clear revision changelog.

Each command writes two files under docs/generated/:

• <name>.md — the editable Markdown source
• <name>.html — opens in your browser; select all → copy → paste into Confluence Cloud

Why HTML for Confluence?

Confluence Cloud does not reliably parse pasted Markdown, but it does convert pasted rich text/HTML into native elements. So docs-agent renders your doc as clean semantic HTML and opens it; you copy the rendered page and paste — headings, tables, code blocks, and lists all become native Confluence content.

How it works

Prompt-first, graph-free. Each command:

1. Gathers real context with small zero-dependency Node helpers (lib/):
   • scan-project.mjs — languages, frameworks, entrypoints, structure
   • collect-diff.mjs — structured git diff (working tree or branch)
   • to-confluence-html.mjs — Markdown → Confluence-safe HTML (+ auto-open)
2. Reads the relevant source (and ticket, for /documentate).
3. Writes the doc from a consistent template (templates/).
4. Converts to HTML and opens it for one-paste publishing.

No knowledge graph, no dashboard, no build step — just documentation.

Install

See install.md for Copilot CLI and VS Code steps.

Demo / examples

See ready-made sample output in examples/:

• onboarding-sample.md / .html — an onboarding guide
• documentate-sample.md / .html — a feature/change doc

Open either .html in a browser, select all, copy, and paste into a Confluence Cloud page to see the native rendering (headings, tables, code blocks, lists) with zero reformatting.

Requirements

• Node.js >= 18 (for the helper scripts)
• Git (for /documentate and /update-documentation)

Development

npm test   # runs node:test over the lib/ helpers

License

MIT