Quick Tour
updated
By the end of this page, you’ll have a workspace, a project, a published document, and a teammate invited. Total time: about 5 minutes.
1. Create your workspace
Your workspace is the top-level container for everything your team does in Meldoc — projects, documents, members, and settings. You only need one per organization.
- Open app.meldoc.io/signup and continue with your email, GitHub or Bitbucket
- Enter your name and accept the Terms of Service
- Name your workspace after your team or company (say, “Dundler Paper Co.”) — it starts on the Free plan, and the next step offers the upgrade
- Invite teammates (on a paid plan), install the GitHub App, connect an AI assistant and choose your emails — the first three can be skipped, and both kinds of email start off; Finish lands you on the workspace Overview
The Start tab lists your projects and what needs you. Right now it’s nearly empty, but that’s about to change — see Workspaces for what fills it.
2. Create a project
Projects group related documents together. You might create one per product, per team, or per topic — whatever makes sense for how your team thinks about documentation.
- On the Overview, select Create project
- Give it a name (e.g., “DundlerOS API”)
- Add an optional description so teammates know what this project covers
- Select Create project
Tip: If Dundler Paper Co. has a backend API and a separate warehouse microservice, those are two separate projects — just like they’re separate repos. Keep things focused; it’s easy to create more later.
3. Write your first document
Documents are individual pages of content, written in Markdown. If you’ve ever edited a GitHub README, you’ll feel right at home.
- Open your new project
- In the sidebar, select Create document
- Give it a title — something like “Authentication” or “Pretzel Day Scheduler”
- Start writing
The editor supports live preview, images, code blocks, tables, and more. See Working with Documents for the full feature rundown.
4. Organize with nesting
Instead of folders, Meldoc uses document hierarchy — documents can have child documents nested underneath them. This keeps your sidebar clean and your content logically grouped.
- Click the More (⋮) menu on the document
- Select Add child
- Give it a title
- The child appears nested under its parent
You can also create a child document by clicking +.
And you can drag and drop documents in the sidebar to reorder or re-parent them.
Your “DundlerOS API” project might have a top-level “Authentication” doc with child docs for “API Keys,” “OAuth Flow,” and “Token Refresh.” Even Michael could follow that hierarchy.
5. Publish and share
New documents start in Published state by default, so your content is live as soon as you write it. Published means your team can see it; to put a document on the public web, open up its access. You have full control over visibility:
- In the toolbar, select Share
- Open the Access tab
- Pick an Access Level — Workspace members (your team only), Anyone with the link, or Public — everyone on the internet. Documents can also inherit from the project.
If a document isn’t ready yet, turn on Draft on the Info tab of the right sidebar. A draft stays inside your workspace whatever its access level, and the Access tab offers no level until you turn Draft off again.
See Document Workflow for workflow details and Document Visibility & Access Level for access control options.
6. Invite your team
Documentation is better together. Bring in your teammates so they can contribute, review, and stay in the loop.
- In the sidebar, open Settings
- Select Members
- Select Invite Member
- Enter their email and pick a role
Keep in mind: Roles range from full admin access to view-only. Choose wisely — you probably don’t want Creed anywhere near the production docs. Team has the full breakdown.
What’s next?
You’ve got the basics down. Here are the best next steps depending on what you want to do:
Meldoc CLI — Sync your docs with a Git repo for version control and code reviews.
Meldoc MCP — Let AI assistants like Claude or Cursor understand your entire codebase through your docs.
Search & AI answers — Find anything across all your projects instantly.
Documents — Deep dive into all the ways you can create and customize content.