Digitorn
Digitorn
← All use cases
developer

Build a documentation generator in YAML

Reads your source, writes back into docs/, opens a PR with the diff for review.

filesystemworkspace
The pattern

A specialised coding agent pointed at your source tree. It reads modules, infers behaviour, and updates the docs site to match. The workspace mirror means the changes hit your repo as a clean PR you can review before merging. The read-before-edit guard makes the output trustworthy.

What good looks like
  • Doc PR within 10 minutes of source change
  • Every code block in docs runs as-shown
  • Cross-links between related sections
  • No stale references after refactors
Common pitfalls
  • Writing docs without reading the source first
  • Drifting away from project conventions over time
  • Updating files in bulk, no review-friendly atomic PRs
  • Hallucinating function signatures from filenames

The minimum YAML to ship this

app.yaml
1modules:2  filesystem: { config: { read_before_edit: true } }3  workspace:4    config:5      render_mode: markdown6      entry_file: docs/index.md7      sync_to_disk: true89agents:10  - id: doc-writer11    modules: [filesystem, workspace]12    brain: { model: claude-sonnet-4-6 }13    system_prompt: "Read src/. Update docs/. One file at a time."
Ship in 5 minutes

Install Digitorn and deploy this agent

# 1. install runtime
curl -sSL https://digitorn.ai/install | sh

# 2. save the YAML above to ~/.digitorn/apps/my-documentation-generator/app.yaml
mkdir -p ~/.digitorn/apps/my-documentation-generator
# paste the YAML into app.yaml

# 3. deploy
digitorn deploy my-documentation-generator
Read the deep dive

10 apps you can ship in 50 lines of YAML

Read article
Newsletter

Get the next post in your inbox.

Engineering notes from the Digitorn team. No marketing, no launch announcements, no "10 prompts that will change your life". Just the things we write that we'd want to read.

One-click unsubscribe. We never share your address. Powered by our own infrastructure, not a tracker.

Other things you can build

communicationSlack copilot/use-cases/slack-botdeveloperAutomated code reviewer/use-cases/code-reviewknowledgeResearch agent with citations/use-cases/research-agentcommunicationVoice assistant/use-cases/voice-assistantopsScheduled reporter/use-cases/cron-reporterdeveloperPR triager/use-cases/pr-triagerknowledgeMeeting note-taker/use-cases/meeting-notesopsEmail triager/use-cases/email-triagecreativeLive React app builder/use-cases/react-builder