Sorrell Docgen

Search documentation

Menu
Documentation for products with more to explain

Sorrell Documentation

Build readable documentation sites with a shared content, theme, and publishing system.

npm install -D @sorrell/docs-create-website

// One config, four useful surfaces

  • 01Versioned guides
  • 02Generated API
  • 03Interactive stories
  • 04Agent-ready output
document-pipeline.ts
01ConfigureRoutes, themes, and packages
02AuthorMarkdown, APIs, and stories
03PublishA connected static site

Author content once and ship guides, API references, interactive stories, and agent-ready output.

// From authored pages to a published site

Start with the guides readers need and leave room for the rest of the product story.

Content

One home for guides and versioned content.

Organize authored pages into stable routes that remain easy to browse as products and versions grow.

Without a shared site config

Guides, release notes, and versioned pages drift across disconnected sites.

With Sorrell Docgen

Keep authored documentation together under clear, predictable routes.

// Built for the real world

One configuration, several useful surfaces.

DocsArchitectureAuthoring

Versioned product documentation

Give tutorials, architecture notes, and authoring guidance stable routes that can evolve with each release.

Browse the docs
01

Guides

References generated from source

Keep package APIs, types, and entry points discoverable next to the guides that explain how to use them.

Browse the API
02

API

Examples you can explore

Pair concepts with interactive components and runnable examples from the web Storybook.

Explore Storybook
03

Stories

A clear path from source to site

Understand how configuration, content, generated routes, and deployment fit together in this repository.

Read the authoring guide
04

Authoring

// Documentation that stays connected

Guides, references, and stories from one source.

Give tutorials, architecture notes, and authoring guidance stable routes that can evolve with each release.

Versioned product documentation

  • Browse the docs
  • Shared light and dark themes
  • Static routes with deployment rewrites

Keep package APIs, types, and entry points discoverable next to the guides that explain how to use them.

References generated from source

  • Browse the API
  • Shared light and dark themes
  • Static routes with deployment rewrites

Pair concepts with interactive components and runnable examples from the web Storybook.

Examples you can explore

  • Explore Storybook
  • Shared light and dark themes
  • Static routes with deployment rewrites

Understand how configuration, content, generated routes, and deployment fit together in this repository.

A clear path from source to site

  • Read the authoring guide
  • Shared light and dark themes
  • Static routes with deployment rewrites

// The site architecture

Keep content, components, and publishing in sync.

A shared configuration connects authored pages, generated references, interactive examples, and the routes readers use.

  • Keep guides and versioned routes together.
  • Generate API references from package entry points.
  • Publish stories and documentation with shared themes.
DocsConfig<Routes, Theme, Packages>

Author

Markdown and code

Generate

API and routes

Publish

Docs and stories
const site = defineDocsConfig(source)
const pages = generateRoutes(site)
publish(pages)

- authored content stays inspectable

- references and stories share the site

Explore the documentation

// Useful for people and tools

Make documentation work for readers and agents.

Versioned guides, generated API references, Storybook, and structured output stay discoverable through one site configuration.

Read the architecture overview
docs.config.ts
const config = defineDocsConfig({
  versions: ["current", "v1"],
  api: { entryPoints: ["Package/Core/Source/index.ts"] },
  storybook: { basePath: "/storybook" }
})

run sorrell-docs create --config docs.config.json
01

Give every product surface a reliable home. Keep onboarding, architecture, API details, and interactive examples within one connected experience.

02

Keep guides close to the code they explain. Generate API references from package entry points and maintain product guidance alongside the source.

03

Make the same knowledge easy to find and reuse. Publish readable pages and structured outputs from a shared documentation source.

// One source, several surfaces

Documentation that grows with the product.

“Give every product surface a reliable home.”

For product teamsSorrell Docgen

“Keep guides close to the code they explain.”

For package authorsSorrell Docgen

“Make the same knowledge easy to find and reuse.”

For readers and agentsSorrell Docgen

// FAQ

Questions teams ask about the documentation system.

Start with the guides your readers need, then add API references, stories, and versions as the product grows.

Explore the documentation
What is included in the documentation site?

The site combines a landing page, authored guides, generated API references, and the web Storybook when enabled in configuration.

Can the site include versioned documentation?

Yes. The configuration supports versioned content and routes so published guides can match the releases readers use.

Are API references maintained by hand?

API pages are generated from configured TypeScript package entry points, keeping the reference connected to source code.

Where should I start?

Read the architecture overview, then follow the authoring guide or browse the API and Storybook from the navigation above.

npx sorrell-docs create --config docs.config.json

Give every product surface a place in the docs.

npm install -D @sorrell/docs-create-website

Read the docsExplore the API