Skip to content

quickstart.mdx

Latest commit

 

History

History
142 lines (102 loc) · 3.77 KB

quickstart.mdx

File metadata and controls

142 lines (102 loc) · 3.77 KB
title Quickstart Guide
description Get up and running with Atriabyte Digital in minutes by setting up your account and creating your first documentation space.

Prerequisites

Ensure you have: - A valid email address for account creation - Browser access (Chrome, Firefox, or Safari recommended) - Team member emails ready for invitations (optional)

Create Your Account

Follow these steps to sign up and access Atriabyte Digital.

Navigate to `https://app.atriabyte.digital` and click **Sign Up**. 
<Image
  src="https://via.placeholder.com/800x400/1863DC/FFFFFF?text=Atriabyte+Digital+Sign+Up"
  alt="Atriabyte Digital sign up page"
  width="800"
  height="400"
/>
Provide your email, create a strong password, and complete the verification. 
Agree to the terms and click **Create Account**.
Check your inbox for a verification link from Atriabyte Digital and click it to activate your account.

Set Up Your First Documentation Space

Once logged in, create your first space to organize documents.

From the dashboard, click **New Space**. 
Enter a name like `Project Docs` and select a template (e.g., "Team Documentation").
Customize permissions, add a description, and set the brand color to `#1863DC`. 
Save changes to activate the space.

Upload Your First Documents

Add content to your space using these methods.

Drag and drop files (PDF, DOCX, MD) into the space editor. 
Or click **Upload** and select files from your device.
Paste a public URL (e.g., GitHub README) in the import field. 
Atriabyte Digital fetches and converts it automatically.
Connect your repo via **Integrations > GitHub**. 
Select branches to sync documentation continuously.

Navigate the Interface

Key areas include:

  • Sidebar: Spaces, search, and recent docs
  • Editor: Real-time markdown/WYSIWYG editing
  • Versions: Track changes and restore
  • Search: Global full-text search across spaces
Use keyboard shortcuts like `Ctrl+K` for quick search.

Invite Team Members

Collaborate by adding users.

In your space, go to **Settings > Members**. Enter emails, select roles (`Editor`, `Viewer`), and click **Invite**. 
Team members receive emails to join.

Next Steps

Secure your spaces with advanced auth options. Tailor themes, permissions, and integrations. Explore AI editing, webhooks, and analytics. Common issues:
Issue Solution
Upload fails Check file size (<10MB) and format
Invite not received Verify spam folder; resend
Sync errors Reconnect GitHub integration
Congratulations! Your first space is ready. Explore the dashboard and build your documentation.