Reads your repo
techwriter.ai clones the watched repository and surveys its structure, READMEs, and public surface to propose a documentation information architecture.
Living documentation engine
Documentation that writes itself
techwriter.ai turns a repository into a documentation site that writes and maintains itself through GitHub Actions. Below: five living knowledge bases, each documenting a real open-source project. Browse the gallery, then point the engine at your own repo.
Knowledge bases5Pages70+Built withDocusaurusDeployed viaGitHub Actions
// The gallery
Five technical knowledge bases
Each is a deep, structured knowledge base for a real open-source project — the writing, the structure, and the cross-links all machine-generated. This is the kind of documentation techwriter.ai produces.
AVIATION · TECH PUBS
S1000D
The international XML standard for aircraft technical manuals — data modules, the Data Module Code, the CSDB, BREX, and Simplified Technical English.
kibook/s1kd-toolsBINARY FORMATS · DSLKaitai Struct
Describe any binary format once in a .ksy file, then compile parsers in a dozen languages. A favourite of reverse engineers and forensics.
kaitai-io/kaitai_structSDR · RF DECODINGrtl_433
Point a $20 software-defined radio at the air and decode 200+ ISM-band devices — weather stations, TPMS, energy meters — into JSON and MQTT.
merbanan/rtl_433SPACE · TELEMETRYCCSDSPy
Read CCSDS telemetry packets from real NASA and NOAA missions — Europa Clipper, GOES-R, PACE — in a few lines of Python.
CCSDSPy/ccsdspySECURITY · THREAT DETECTIONYARA-X
VirusTotal's Rust rewrite of YARA — the rule language malware hunters use to fingerprint and classify files.
VirusTotal/yara-x// How it works01 / READ 02 / WRITE 03 / WATCH
Three moves, on a loop
techwriter.ai runs as a GitHub Action on your repository: read, write, watch — repeated every time your code changes.
Writes the docs
It writes Markdown pages and the sidebar that hold the knowledge base together — the entire content contract is files in docs/.
Watches your PRs
On every merged pull request it decides whether the docs need to change and, if so, opens a doc-update PR you review and merge.
// Make it your own
From repo to living docs in four steps
Point the same engine at your own repository. No content database to host — everything lives in your GitHub repo.
- 1
Sign in with GitHub
One identity authorizes scaffolding the docs repo and enabling Pages.
- 2
Pick a repo to watch
Choose the codebase whose changes techwriter.ai should keep the docs in sync with.
- 3
Add your Claude credential
An Anthropic API key or your Claude Pro/Max subscription token — your model, your spend. You can even bring your own agent.
- 4
techwriter.ai builds & maintains
It opens an initial documentation PR, then keeps it current as PRs merge.
Your credential is encrypted and saved as an Actions secret in your own GitHub repository — it stays in your GitHub account, and you can revoke it any time.
Connect your GitHub →Opens the techwriter.ai onboarding: pick a repo to watch, choose whole-repo build and/or PR-sync, add your key — and it provisions a brand-new docs site that's yours.