Creating and Configuring Projects
updated
A project is a collection of related documents with its own access level, contributors, document types and, optionally, a connected repository.
Create a project
On the workspace Overview, select Create project. Give it a Name, an optional Description, an optional Alias and optional Agent instructions. You become its Admin.
The alias names the project in public URLs, in projectAlias of meldoc.config.yml, in MCP calls and in cross-project Magic Links (Wiki Links) such as [[api-docs::getting-started]]: lowercase letters, digits and hyphens, unique in the workspace. Left empty, it is generated from the name — API Docs becomes api-docs, with -2 added if that is taken — and the form shows it before you continue.
Agent instructions are this project’s own rules for AI assistants connected over Meldoc MCP, on top of the workspace’s; leave them empty unless the project is an exception.
The setup then offers to connect a repository (Connect and Disconnect), pick a starting set of Document Types, and add contributors. Every step can be skipped and done later. A new project is private.
Settings
Open the gear icon in the project header. The settings are split into sections, listed on the left — on a phone, as a list you open one section from:
- General — name, description and alias.
- Agent instructions — this project’s own rules for AI assistants.
- Repository sync — what a sync does with a document that disappeared from the repository: delete it or move it to the archive.
- Canonical URL — see Serving a Project from Your Own Address.
- Sources — the projects this one follows; see Keeping a Project in Step with Its Sources. Shown only where Sources is switched on.
- Delete project — for project Admins.
General, Agent instructions and Repository sync are saved together with Save changes; a dot beside a section marks an edit not saved yet. Canonical URL and Sources save on their own.
Renaming the alias? Links inside Meldoc follow it, but public URLs use the current alias only. If a repository syncs the project, update
projectAliasinmeldoc.config.ymland any GitHub branch-protection rules that require theMeldoc syncorMeldoc reviewchecks by name. See Renaming & Redirects.
Canonical URL
To serve the project from an address on your own site, see Serving a Project from Your Own Address.
Access level
| Level | Who can open it |
|---|---|
| Private | Workspace members only |
| Unlisted | Anyone with the link; not listed or indexed |
| Public | Everyone, discoverable via search |
Unlisted and public projects are served at https://public.meldoc.io/<workspace>/<project-alias> and need an alias and published documents. Documents inherit the project’s level and can override it — see Document Visibility & Access Level. Public and unlisted projects need a paid plan.
Collaborators
Workspace Members can read every project but not edit by default. Add a collaborator to grant one of these roles on a single project:
| Role | Can |
|---|---|
| Write | Create and edit documents |
| Write and Delete | Also delete documents and edit project settings |
| Admin | Also manage collaborators and delete the project |
To grant access to a group at once, use a Team. Workspace Admins and Owners always have full access.
What’s next?
Custom Fields and Document Types — Structure your documents.
GitHub Sync — Sync the project with a repository.