Skip to main content

Modes

Modes define what type of documentation is generated. Each mode is a Markdown prompt file in the modes/ directory — no compiled code, fully customizable.

Selecting a mode​

npm run generate -- --file input/my-transcript.md --type <mode>

Or set the default in your config:

config/devdocs-forge-agent.yml
project:
  default_output_type: "docusaurus"

Available modes​

docusaurus — Docusaurus v3 documentation page​

Generates a full Docusaurus page with YAML frontmatter, correct heading structure, and admonition-ready content. Also writes a copy to docs/{slug}.md ready for your Docusaurus project.

npm run generate -- --file input/tutorial.md --type docusaurus

Output includes: YAML frontmatter (id, title, sidebar_label, tags, description), prerequisites, step-by-step guide, code blocks, review checklist.

blog — Developer blog post​

Generates a blog post with a hook intro, background section, main content, code examples, key takeaways, and SEO tags.

npm run generate -- --file input/tutorial.md --type blog

docs — General documentation page​

General-purpose documentation page for any docs system. Includes overview, prerequisites, core concepts, step-by-step instructions, and troubleshooting.

npm run generate -- --file input/tutorial.md --type docs

gitbook — GitBook documentation page​

GitBook-formatted markdown with hint blocks ({% hint style="info" %}), standard heading structure, and page navigation hints.

npm run generate -- --file input/tutorial.md --type gitbook

readme — GitHub README tutorial​

README-style tutorial with badges placeholder, quick start commands, API reference table, and installation guide.

npm run generate -- --file input/tutorial.md --type readme

faq — FAQ document​

Categorized FAQs written the way developers actually ask questions: "How do I...?", "Why is my...?", "What happens when...?"

npm run generate -- --file input/tutorial.md --type faq

troubleshooting — Troubleshooting guide​

Structured guide with symptom → cause → fix format, diagnostic checklist, and escalation path.

npm run generate -- --file input/tutorial.md --type troubleshooting

lesson — Course lesson page​

Course lesson with learning objectives, prerequisites, core content, knowledge checks, and a hands-on exercise.

npm run generate -- --file input/tutorial.md --type lesson

social — Social media summaries​

LinkedIn post, X (Twitter) thread opener, and dev.to intro — all in one output.

npm run generate -- --file input/tutorial.md --type social

changelog — Release notes​

Keep A Changelog format with Added/Changed/Fixed/Removed sections.

npm run generate -- --file input/tutorial.md --type changelog

seo — SEO metadata​

Title tags, meta descriptions, Open Graph tags, Twitter Card tags, and keyword analysis.

npm run generate -- --file input/tutorial.md --type seo

Adding a mode​

  1. Create modes/yourmode.md with prompt instructions for the AI
  2. Add the mode name to VALID_MODES in src/pipeline/prompt-builder.ts
  3. Test with npm run generate -- --file examples/transcripts/angular-signals-tutorial.md --type yourmode

Adding a mode requires zero TypeScript knowledge. See GitHub Issue #3 — Mermaid diagram mode is a good first contribution.

Batch mode​

Process all transcripts in a directory with the same mode:

npm run batch -- --dir input/
npm run batch -- --dir input/ --type blog