Getting Started
DocStar is a documentation platform built for teams. Your team writes and organizes knowledge together in one shared workspace, and you choose what stays internal and what gets published as product docs, help docs, API docs or a blog.
How DocStar is organized
Everything in DocStar sits in three levels.
| Level | What it is | Example |
|---|---|---|
| Workspace | Your team's home. It holds your members, their roles and all your collections. | "Acme Inc" |
| Collection | One set of docs with its own type, settings, branding and (optionally) public site. | "Help Center", "Public API", "Engineering Wiki" |
| Page | A single document inside a collection. Pages can have subpages. API collections also hold endpoints. | "Getting started", "Create an order" |
You can belong to several workspaces and switch between them at any time.
Team-first by default
- Shared. Everyone in the workspace works in the same collections. Owners and Admins decide who can read or edit each collection.
- Structured. Pages live in a tree of pages and subpages, so large docs stay easy to navigate.
- Versioned. DocStar keeps the history of each page, so you can see what changed and go back.
- Real-time. Several people can edit the same page at once.
Internal vs published
A collection is private until you publish it. While it is private, only members of your workspace with access to that collection can see it.
When you publish a collection, it gets a live site. You can keep that site open to everyone, or limit it with a password or an IP allowlist.
Drafts vs published pages
Every page starts as a draft. Drafts are visible only inside your workspace. When a page is ready, you publish it and it appears on the live site. Edits you make later stay in the draft until you publish the page again, so readers never see half-finished work.
Where to go next
- Quick Start: create your first collection, write a page and publish it.
- Choose Your Docs Type: pick between Doc, API, Blogs and Embed collections.
- Import Content: bring in OpenAPI, Swagger, Postman or Markdown content.
- Workspaces & Team: invite your team and set permissions.
- Collections & Pages: organize your content.
- Writing & Formatting: learn the editor.
- Publish & SEO: put your docs online.
- API Documentation: document and test your APIs.