Baudhik AI
GuidesOrganizing Docs

Organizing Documentation

Learn how to structure, categorize, and maintain your project documentation effectively.

Overview

Organizing your documentation effectively helps users find information quickly and keeps your project maintainable. With Baudhik AI, you control the structure through simple file and folder conventions that map directly to your navigation.

Creating and Nesting Pages

Start by creating new MDX files in your docs directory. Each file becomes a page in your documentation site.

Create a new page

Add a new .mdx file in your content directory. Name it descriptively, such as authentication.mdx.

Add frontmatter

Include required YAML frontmatter at the top of every file:

---
title: Authentication
description: Learn how to secure your API requests.
---

Nest pages with folders

Create subfolders to group related topics. For example, place all API guides inside an api/ directory.

Using Folders and Sections

Organize content hierarchically using folders. This approach automatically generates section groupings in your sidebar navigation.

docs/
├── introduction.mdx
├── quickstart.mdx
├── api/
│   ├── authentication.mdx
│   └── endpoints.mdx
└── guides/
    ├── organizing-docs.mdx
    └── deployment.mdx

Use the pages configuration in your docs setup to control order and visibility of these sections.

Version Control Basics

Treat your documentation like code. Use Git to track changes and collaborate with your team.

Commit documentation updates alongside code changes to keep everything synchronized.

Follow these practices:

  • Write clear commit messages such as "docs: add rate limiting guide"
  • Create branches for large documentation overhauls
  • Review documentation changes using pull requests

Search and Navigation Tips

Improve discoverability with these techniques:

Use descriptive titles

Clear page titles help both search engines and users.

Add keywords in descriptions

Descriptions improve internal search results.

For advanced navigation, combine folders with custom sidebar ordering. This keeps your documentation scalable as your product grows.

Was this page helpful?

Last updated today

Built with Documentation.AI