Quickstart Guide

Get up and running with SynthralOS in minutes, from account creation to setting up your first documentation space.

Prerequisites

Ensure you have:

A modern web browser like Chrome, Firefox, or Safari
An email address for account verification
Optional: Existing Markdown files or GitHub repo for import

SynthralOS makes it easy to create and manage documentation spaces. Follow these steps to set up your first workspace.

Step-by-Step Setup

Create Account

Visit https://dashboard.example.com and click Sign Up.

Fill in your email, password, and workspace name. Verify your email to activate the account.

Use a strong password and enable two-factor authentication later for security.

Set Up Workspace

After login, you'll land in your new workspace dashboard.

Customize your workspace:

Add team members via the Members tab
Set branding colors (e.g., #79FFE1 for your brand)
Configure navigation sidebar

// Example workspace config (via API)
const config = {
  name: "Customer Documentation",
  color: "#79FFE1",
  members: ["user@example.com"]
};

Import Documentation

Import existing content to jumpstart your docs.

Drag and drop .md files or use the import wizard.

# Welcome to SynthralOS

This is your first imported document.

## Features

- Real-time editing
- Version history
```

Navigate the Interface

Explore key areas:

Area	Purpose
Sidebar	Document tree and search
Editor	Real-time Markdown/ WYSIWYG
Preview	Live rendering with themes
Publish	Deploy to custom domain

Key shortcuts: <kbd>Ctrl</kbd>+<kbd>S</kbd> to save, Ctrl+K for search.

Publish First Document

Edit your doc, then click Publish.

Set domain: docs.yourcompany.com.

// API publish example
await fetch('https://api.example.com/v1/docs/publish', {
  method: 'POST',
  headers: { 'Authorization': 'Bearer YOUR_TOKEN' },
  body: JSON.stringify({ docId: 'doc-123', domain: 'docs.example.com' })
});

Your site goes live instantly!

Next Steps

Authentication

Secure your workspace with API keys and SSO.

Advanced Guides

Dive deeper into features and customization.

Changelog

Stay updated with latest releases.

Congratulations! You've published your first SynthralOS documentation. Explore the dashboard to add more spaces and collaborate with your team.

Import fails: Check file size (<10MB) and format.
Publish errors: Verify domain DNS points to SynthralOS.
Contact support@synthralos.com for help.

Was this page helpful?

Last updated Mar 13, 2026

Built with Documentation.AI