Skip to content

faq.mdx

Latest commit

 

History

History
144 lines (102 loc) · 3.69 KB

faq.mdx

File metadata and controls

144 lines (102 loc) · 3.69 KB
title Frequently Asked Questions
description Common questions and answers about using Paperguide for documentation management.

Overview

Paperguide helps you organize and manage project documentation efficiently. You will find answers to common questions about accounts, billing, troubleshooting, and best practices below. Use the expandable sections to explore specific topics.

Manage your subscription and account settings. Resolve common issues quickly. Tips for effective documentation.

Account and Billing

Sign up at https://app.paperguide.com/register using your email. Verify your account via the confirmation link sent to your inbox. You gain immediate access to a free trial with full features.

Review plans in your dashboard under Settings > Billing.

Plan Price Features
Free $0/mo 1 doc space, 5 pages, basic editor
Pro $19/mo Unlimited spaces, custom domains
Team $49/mo Collaboration, analytics

Upgrade anytime via the billing portal.

Navigate to Settings > Billing > Payment Methods. Add a new card or update existing ones. Paperguide uses Stripe for secure processing—expect no storage of full card details on our servers.

Cancel subscriptions before the billing cycle ends to avoid charges.

Troubleshooting

Check your internet connection first. Paperguide requires a stable `{https}` connection.

If the editor freezes:

Press `Ctrl+R` (`Cmd+R` on macOS) to reload the page. Open dev tools (`F12`), go to Application > Storage, and clear site data. Close all tabs and relaunch your browser.

Content not saving? Verify your {API_KEY} in project settings.

// Check network tab for errors
fetch('/api/sync', {
  headers: { 'Authorization': `Bearer ${YOUR_API_KEY}` }
})

Contact support if errors persist.

Best Practices

Follow these guidelines to create high-quality documentation.

```mdx ## Heading Structure

Use H2 for main sections, H3 for subsections.

Always escape special characters like `{variable}`. ``` ```markdown # Avoid H1 in body

Use H2 first

  • Lists for steps
  • Inline code for variables
</CodeGroup>

<Expandable title="Advanced MDX Tips">

Nest components properly:

````jsx
<Steps>
<Step title="Step 1">
  ```bash
  npm install paperguide-sdk
  ```
</Step>
</Steps>

Use 4 backticks for nested code blocks to prevent parsing errors.

For collaboration, assign roles in team settings. Review changes via the version history panel. Export docs as PDF or HTML for sharing.

Regularly back up your spaces using the export feature.