Skip to main content

Quick Start

Generate your first doc in under 5 minutes. No API key needed.

Prerequisites​

  • Node.js 18 or later
  • npm 9 or later
  • Git
Check prerequisites
node --version   # v18.x.x or higher
npm --version    # v9.x.x or higher
git --version

1. Clone and install​

Install DevDocs Forge Agent
git clone https://github.com/AnkitParekh007/devdocs-forge-agent.git
cd devdocs-forge-agent
npm install

2. Configure environment​

Create local environment file
cp .env.example .env

The default configuration uses mock mode — no API key required.

.env
DEVDOCS_PROVIDER=mock

3. Run the demo​

Run the local demo
npm run demo

This single command:

  1. Runs doctor to validate your setup
  2. Copies example transcripts to input/
  3. Generates a Docusaurus page from the Angular Signals tutorial
  4. Runs verify to validate the output

4. View the output​

Generated files appear in output/angular-signals-tutorial-{date}/.

Generated output
output/angular-signals-tutorial-2026-05-13/
├── index.md
├── metadata.json
├── review-checklist.md
├── source-summary.md
└── docs/
    └── angular-signals-tutorial.md
FilePurpose
index.mdMain generated documentation
metadata.jsonProvider, model, timestamp, and warnings
review-checklist.mdHuman review checklist before publishing
source-summary.mdSource stats and attribution summary
docs/angular-signals-tutorial.mdDocusaurus-ready page with frontmatter

5. Generate from your own transcript​

Drop your transcript into input/ and run:

Generate Docusaurus docs
npm run generate -- --file input/my-tutorial.md --type docusaurus

Choose a different output mode:

Generate different output types
npm run generate -- --file input/my-tutorial.md --type blog
npm run generate -- --file input/my-tutorial.md --type faq
npm run generate -- --file input/my-tutorial.md --type readme

Test with a YouTube URL​

DevDocs Forge Agent does not scrape YouTube transcripts or download videos. A video URL is used only for metadata, source attribution, and safety checks. You must provide your own transcript file.

1. Inspect a video URL​

Inspect a video URL
npm run devdocs-forge-agent -- inspect-url "https://www.youtube.com/watch?v=W6NZfCO5SIk"

2. Validate URL + transcript together​

Validate source URL and transcript
npm run devdocs-forge-agent -- validate-source \
  --url "https://www.youtube.com/watch?v=W6NZfCO5SIk" \
  --file input/my-transcript.md

3. Generate docs safely​

Generate docs with Video Intake Guard
npm run generate -- \
  --url "https://www.youtube.com/watch?v=W6NZfCO5SIk" \
  --file input/my-transcript.md \
  --type docusaurus
URL-only generation is blocked

This command intentionally fails because no transcript file is provided:

npm run generate -- --url "https://www.youtube.com/watch?v=W6NZfCO5SIk"

DevDocs Forge Agent requires --file input/my-transcript.md to avoid scraping and hallucinated documentation.

Switch to a real AI provider​

Edit .env:

.env
DEVDOCS_PROVIDER=openai
OPENAI_API_KEY=sk-...
OPENAI_MODEL=gpt-4.1-mini

Then run:

Generate with configured provider
npm run generate -- --file input/my-tutorial.md --type docusaurus

See Providers for Anthropic and Gemini setup.

Mock mode first

Always test with mock mode before spending API credits. Mock mode generates the full file structure with placeholder content so you can verify the workflow works.

Next steps​