> ## Documentation Index
> Fetch the complete documentation index at: https://docs.3cool.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# Documentation workflow: write, organize, and publish

> Understand the end-to-end workflow for creating, organizing, and publishing documentation with 通用文档站点 from first page to live site.

通用文档站点 gives you a structured, end-to-end workflow for turning your writing into a polished, published documentation site. This page walks you through the three core stages — writing content, organizing it into a navigable structure, and publishing it for your users.

## How it works

Every documentation project in 通用文档站点 follows the same path from draft to live site. Start by writing your pages in MDX, arrange them into a logical structure using `docs.json`, then publish with a single deployment step.

<CardGroup cols={3}>
  <Card title="Write" icon="pen-to-square" href="/guides/content">
    Create pages using Markdown and MDX components to communicate clearly with your users.
  </Card>

  <Card title="Organize" icon="sitemap" href="/guides/navigation">
    Structure your pages into groups and tabs so users can find what they need quickly.
  </Card>

  <Card title="Publish" icon="globe" href="/quickstart">
    Deploy your documentation site and make it available to the world.
  </Card>
</CardGroup>

## The docs.json file

`docs.json` is the central configuration file for your documentation site. It controls your site's navigation structure, visual theme, brand colors, and metadata — everything that shapes how your site looks and behaves. You place this file at the root of your docs folder and update it whenever you add pages or change your site's appearance.

Here is a minimal `docs.json` to get you started:

```json docs.json theme={null}
{
  "$schema": "https://mintlify.com/docs.json",
  "name": "My Docs",
  "theme": "willow",
  "colors": { "primary": "#4F6AF0" },
  "navigation": {
    "groups": [
      { "group": "Get Started", "pages": ["introduction"] }
    ]
  }
}
```

## File structure

A typical 通用文档站点 project follows a straightforward folder layout. Your `docs.json` lives at the root alongside your top-level pages, and subdirectories group related content together.

```text theme={null}
docs/
├── docs.json
├── index.mdx
├── introduction.mdx
└── guides/
    └── overview.mdx
```

Each `.mdx` file corresponds to one page on your site. The file path maps directly to the page URL, so `guides/overview.mdx` becomes `/guides/overview` on your live site.

<Tip>
  Keep page filenames lowercase and use hyphens instead of spaces or underscores — for example, `getting-started.mdx` rather than `Getting Started.mdx`. This produces clean, readable URLs for your users.
</Tip>
