Guides

Welcome

A small docs workspace used to prove DevDocs dashboard imports, previews, and production deploys.

DevDocs AI Sample is a customer-facing documentation workspace used to prove the DevDocs dashboard lifecycle end to end.

This repo behaves like a Mintlify-style customer repository: it contains docs configuration, MDX pages, OpenAPI descriptions, snippets, and docs assets. The product application source stays elsewhere.

What this proves

  • Production publishes from the main branch.
  • Pull requests create preview environments.
  • Manual branch previews can be created from the dashboard.
  • Theme settings are read from docs configuration and rendered for customer docs.
  • API descriptions can be included without adding application code.

<Snippet file="/snippets/install.mdx" />

Next step

Open the quickstart to make a safe documentation change and verify the preview pipeline.

Feedback

Was this page helpful?

Help us keep Welcome sharp for readers and API explorers.