Quickstart

Create, customize, and publish your first Documentation.AI site in minutes.

Overview

When you create a new documentation, Documentation.AI automatically generates a personalized, branded documentation site. This includes:

• A live URL
• Starter pages and navigation
• Your brand colors and logo fetched from your website (if available and if you choose personalization)
• AI‑powered search and assistance

This quickstart walks you through accessing your site, choosing an editing workflow, making your first update, and publishing changes.

1. Access your live documentation site

After creating a project, your site is deployed automatically. You can find your live URL in the project dashboard under Site URL.

Example format:

• https://your-docs.documentationai.com

Use this URL to preview changes and share drafts with teammates.

2. Choose your editing workflow

Documentation.AI supports two workflows: Web Editor and Code Editor. Both will always be in sync. You can choose whichever you are comfortable.

Web Editor

Use the in-browser Web Editor to create, edit, organize, and publish content visually. This is the fastest way to publish without using version control.

Code Editor

Use Git-backed editing with GitHub or GitLab. Edit locally in your preferred IDE and use pull requests for review. Ideal for engineering teams and version-controlled workflows.

3. Make your first edit

You will now update the auto-generated Getting Started page. Follow the steps for the workflow you selected.

Web Editor workflow

Open the Getting Started page from the sidebar in the dashboard.

1. Click Edit Page.
2. Place your cursor anywhere in the page.
3. Type to / see the list of components available.
4. Start writing and click Publish to push the change live.

• You can also use the built-in AI Documentation Agent to generate or refine content directly in the editor.

For more detail, see the Web Editor Overview.

Code Editor workflow

1. Set up Git integration in Settings → Git Settings.

2. Clone your repository:

git clone https://github.com/your-org/your-docs.git

3. Edit the `getting-started` pages in your editor.
4. Add a component such as a callout:

5. Commit and push:

   git add .
   git commit -m "First content update"
   git push origin main
   

Your updates deploy automatically.

You can optionally use AI-powered IDE assistants, such as Cursor or similar tools, to help edit MDX content locally.

Learn more in the Code Editor Overview.

4. Publish changes

Publishing behaves differently depending on your workflow.

Publish with Web Editor

Click Publish in the top-right corner of the Web Editor. Changes deploy immediately.

Publish with Code Editor

Commits to your main branch trigger automatic deployment.

5. Optional: connect a custom domain

If you want branded docs like docs.yourcompany.com, configure a custom domain.

6. Enhance your site

After publishing your first update, explore these features to extend your documentation.

Import your API schema

Auto-generate API reference pages from your OpenAPI spec.

Add branding

Update colors, logos, and typography.

Use more components

Insert cards, diagrams, steps, tabs, media, and more.

Optimize metadata

Configure meta tags and search visibility.