Creating Your First Document

Step-by-step guide to creating your first documentation page

Creating Your First Document

This guide will walk you through creating your first documentation page step by step.

Step 1: Choose a Location

Decide where your document should go:

  • New section: Create a new folder in content/docs/
  • Existing section: Add to an existing folder
  • New subsection: Create a nested folder

Step 2: Create the File

Create a new .mdx file with a descriptive name:

Step 3: Add Frontmatter

Every document needs frontmatter at the top:

Required fields:

  • title: The document title (appears in sidebar and page header)
  • description: Brief description (appears in listings and meta tags)
  • publishedAt: Publication date (YYYY-MM-DD format)

Optional fields:

  • updatedAt: Last update date (YYYY-MM-DD format)

Step 4: Write Your Content

Write your content using Markdown or MDX:

Next Steps

Step 2: Install Dependencies

Step 3: Start Development Server

Verification

To verify the installation worked:

  1. Open your browser
  2. Navigate to http://localhost:3000
  3. You should see the homepage

Troubleshooting

If you encounter issues, check the Troubleshooting Guide.

Next Steps

Prev
Understanding Documentation Structure
Next
Troubleshooting