Quickstart Guide
Get up and running with Sleeve in minutes
Get your Sleeve workspace set up and create your first document in just a few minutes.
This guide assumes you've already signed in to Sleeve with GitHub. If not, head to the homepage and sign in.
Step 1: Create Your Organization
Organizations are the top-level containers for all your documentation. Think of them as your company or main workspace.
Sign in to Sleeve using your GitHub account.
After signing in for the first time, you'll be prompted to create your first organization. Give it a name (usually your company name).
You'll be redirected to your workspace where you can start organizing your documentation.
Step 2: Set Up Your First Team and Space
Now that you have an organization, let's create a team and space to organize your docs.
Public vs Private Spaces: Public spaces are visible across your entire organization but still require authentication. They are not publicly accessible on the internet.
Step 3: Write Your First Document
Now you're ready to create content!
- Navigate to your space
- Click "New Document"
- Add a title and optional description
- Optionally add an emoji icon
Use the powerful MDX editor to write your content:
- Rich text editing: Visual formatting toolbar
- Live preview: See changes in real-time
- Markdown support: Full Markdown and MDX syntax
- Custom components: Use cards, callouts, tabs, and more
- Link suggestions: When typing
[](), get dropdown suggestions of other team docs
Use the "Edit Layout" button when viewing a document to organize your documentation structure. This is especially important for public spaces to ensure proper navigation.
Press ⌘J (Mac) or Ctrl+J (Windows/Linux) while editing to open the AI writing assistant. Press ⌘I to open a dropdown of all available components and snippets.
Your document auto-saves as you type. When ready, click "Publish" to make it available to your team.
The AI writing assistant is context-aware! It searches your existing documentation to provide relevant suggestions.
Step 4: Set Up GitHub Integration (Optional)
GitHub integration provides centralized version control and synchronization. You can use Sleeve without GitHub integration, but you won't be able to bring in projects/static sites and manage those docs as well.
Click the Settings icon in the upper-right corner of your workspace.
Select "Integrations" from the sidebar.
- Click "Add Integration" and choose GitHub
- You'll need to create a GitHub fine-grained personal access token
- Go to GitHub Settings → Developer settings → Personal access tokens → Fine-grained tokens
- Click "Generate new token"
Set up the token with these permissions:
Repository access:
- All repositories (or select specific repositories)
Permissions:
- Contents: Read and write
- Pull requests: Read and write
Copy the generated token and paste it into Sleeve. Click "Connect".
GitHub integration is essential for Sleeve's version control features. Without it, you won't be able to sync your docs with repositories or use automatic backups.
Step 5: Add a Repository to Your Space
Once GitHub is connected, you can link repositories to your spaces for automatic synchronization.
Next Steps
Explore Features
Learn about the MDX editor, live preview, and AI assistant
MDX Components
Discover all available components for rich documentation
Set Up MCP Server
Integrate Sleeve with Cursor and other AI development tools
Invite Team Members
Add team members to collaborate on documentation
Invite Team Members
Go to the team you want to add members to.
- Click the "Share" button
- Enter email addresses of team members
- Assign roles:
- Admin: Full control over team and spaces
- Member: Can create and edit documents
- Viewer: Read-only access
Congratulations! You're all set up. Start creating amazing documentation with Sleeve!