Skip to main content

Documentation

Learn how Inkwell Forge works

Everything you need to connect your repository, generate documentation, and get the most out of the platform.

Getting Started

Connect your first repository, run a scan, and generate your first deliverable in under 5 minutes.

  • Sign up and connect GitHub or GitLab
  • Select a repository and run discovery
  • Choose screens and deliverables
  • Review the cost estimate and generate

Deliverable Types

Inkwell Forge produces 36 deliverable types across 8 lifecycle categories. Each is built against named professional standards.

  • End-User & Training (7 types)
  • Planning & Architecture (4 types)
  • Development (6 types)
  • Business Analysis (4 types)
  • QA & Testing (4 types)
  • Security & Compliance (4 types)
  • Deployment & Operations (3 types)
  • Maintenance & Handoff (4 types)

Output Formats

Every deliverable can be exported in the format that fits your workflow.

  • Markdown (.md) — for repos and wikis
  • Word (.docx) — for editing and client delivery
  • PDF (.pdf) — for formal submissions and audits
  • HTML (.html) — for web publishing
  • Excel (.xlsx) — for tabular data deliverables
  • CSV (.csv) — for data import
  • JSON (.json) — for structured data and integrations

Billing & Plans

Understand how pricing works, how credits are applied, and how to manage your subscription.

  • Free tier: 1 screen + 1 deliverable per month
  • Pay-as-you-go: no subscription, pay per run
  • Starter: $39/mo with credits and lower rates
  • Pro: $79/mo with full access and priority
  • You always see the exact cost before generating

Supported Frameworks

Inkwell Forge understands routing conventions and file structures for major web and mobile frameworks.

  • Next.js (App Router and Pages Router)
  • React Router, Remix, Angular
  • Vue/Nuxt, SvelteKit, Astro
  • Expo Router, React Native

Standards & Quality

Every deliverable is validated against 2-4 industry standards specific to its document type.

  • 50+ professional standards referenced
  • 9 transparency elements per document
  • Three-tier marker system (documented / inferred / gap)
  • Cross-screen workflow warnings
  • WHO/WHAT/WHERE specificity for all gaps

Ready to get started?

Sign up free and generate your first deliverable in under 5 minutes. No credit card required.