Skip to content

Latest commit

 

History

History
125 lines (106 loc) · 3.59 KB

File metadata and controls

125 lines (106 loc) · 3.59 KB
title Quick Start Guide
description Get up and running with Paperguide by setting up your first documentation space quickly.

Get Started in Minutes

Paperguide helps you organize project documentation in customizable spaces. Follow these steps to create your account, set up a space, and explore the interface. You complete setup in under five minutes.

New to Paperguide? No prior setup required. Use your email or GitHub account.

Create Your Account

Sign up quickly to access your dashboard.

Go to [https://app.paperguide.com](https://app.paperguide.com) and click **Sign Up**. Select **Email**, **GitHub**, or **Google**. Enter your details. Check your inbox and click the verification link. Log in to see your empty workspace.

Set Up Your First Space

Create a documentation space for your project.

Click **New Space** in the sidebar. Enter `My Project Docs` and select a color like `#3B82F6`. Create pages like `quickstart.mdx` and `api.mdx`. Use the API to automate space creation.
<CodeGroup tabs="JavaScript,cURL">
  ```javascript
  const response = await fetch('https://api.paperguide.com/v1/spaces', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${YOUR_API_KEY}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: 'My Project Docs',
      color: '#3B82F6'
    })
  });
  const space = await response.json();
  console.log(space.id);
  ```
  ```bash
  curl -X POST https://api.paperguide.com/v1/spaces \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "My Project Docs",
      "color": "#3B82F6"
    }'
  ```
</CodeGroup>
Generate your `{API_KEY}` from **Settings > API** after login.

Basic Navigation

The interface centers around spaces, pages, and search.

graph TD
    A[Dashboard] --> B[Spaces]
    B --> C[Pages]
    C --> D[Editor]
    A --> E[Search]
    A --> F[Settings]
Loading
Section Icon Action
Spaces folder Manage doc collections
Pages file Edit MDX content
Search search Find docs instantly
Settings settings Configure space
Use keyboard shortcuts: Ctrl+K for search, Ctrl+S to save.

Next Steps

Explore these resources to build your docs.

Learn components like `` and ``. Integrate with your apps. Match your brand with colors.