/
Documentation

Quick Tour

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.

  1. Open app.meldoc.io and sign up
  2. Create your first workspace — name it after your team or company (say, “Dundler Paper Co.”)
  3. You’ll land on the workspace Overview — this is your home base from now on

The Summary tab shows all your projects at a glance. Right now it’s empty, but that’s about to change.

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.

  1. On the Overview, select Create project
  2. Give it a name (e.g., “DundlerOS API”)
  3. Add an optional description so teammates know what this project covers
  4. 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.

  1. Open your new project
  2. In the sidebar, select Create document
  3. Give it a File Name — something like “Authentication” or “Pretzel Day Scheduler”
  4. Start writing

The editor supports live preview, images, code blocks, tables, and more. See Document Editor 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.

  1. Click the More (⋮) menu on the document
  2. Select Add child
  3. Give it a File Name
  4. The child appears nested under its parent

You can also create a child document by clicking +.

Nested child documents in the sidebar

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:

  1. In the toolbar, select Share
  2. Open the Access tab
  3. Set the Status — keep it as Published, or switch to Draft if it’s not ready yet
  4. 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.

Share panel with the Access tab open

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.

  1. In the sidebar, open Settings
  2. Select Members
  3. Select Invite Member
  4. 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 Roles & Permissions 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 & Ask AI — Find anything across all your projects instantly.

Documents — Deep dive into all the ways you can create and customize content.