managing-docs.mdx

title	Managing Your Documentation
description	Learn how to create, organize, and maintain documentation within your Paperguide projects.

Overview

Paperguide lets you build and manage comprehensive documentation sites. You create pages using MDX files, organize them into hierarchies, and collaborate with your team. Maintain version history to track changes over time.

Start with a clear structure. Plan your navigation before creating pages to ensure intuitive user experience.

Creating and Editing Pages

Create new documentation pages directly in your project repository. Use the file system to add .mdx files in your docs/ directory.

Navigate to your project's `docs/` folder. Add a new file like `quickstart.mdx`.

```mdx
---
title: Quickstart Guide
description: Get started with Paperguide in minutes.
---

## Introduction
Welcome to your first page.
```

Open the file in your editor. Add headings, components, and code examples. Preview changes locally with `npm run dev`. Commit and push to your main branch. Paperguide deploys automatically. Always include YAML frontmatter at the top of each `.mdx` file for metadata like `title` and `description`.

Organizing Content Hierarchy

Structure your docs with folders and navigation configuration. Use sidebar menus to create logical hierarchies.

Organize files in nested folders for automatic hierarchy.

```
docs/
├── introduction.mdx
├── guides/
│   ├── setup.mdx
│   └── advanced.mdx
└── api/
    └── reference.mdx
```

Customize sidebar order in `nav.ts` or similar config file.

```typescript
export const nav = [
  { title: "Introduction", href: "/introduction" },
  {
    title: "Guides",
    items: [
      { title: "Setup", href: "/guides/setup" },
      { title: "Advanced", href: "/guides/advanced" }
    ]
  }
];
```

Drag and drop in the Paperguide editor to adjust hierarchy. Categorize pages with metadata for dynamic filtering.

Collaboration and Version History

Invite team members to your Paperguide project for real-time collaboration. Track changes with Git-based version history.

Key Features

Feature	Description	Benefit
Pull Requests	Review changes before merging	Prevents errors
Version History	View diffs and revert	Easy rollback
Comments	Inline feedback on pages	Faster reviews
Branches	Work on features separately	Isolated development

Access history via the page editor. Click "History" to see commits, authors, and diffs.

Compare versions side-by-side to identify changes.

During merges, Paperguide highlights conflicts. Edit directly in the web editor. Share your project link. Assign reviewers to pull requests. Comment on specific lines. Approve or request changes. Merge to main. Site updates instantly. Enable branch previews for testing changes without affecting production.