Skip to content

Workspaces and pages

Organizations, spaces, and pages

An organization is the top-level collaboration boundary. Members, invitations, spaces, sites, and plugin enablement are organized around it.

A space is a documentation project within an organization. Each space has:

  • A name, slug, and optional description.
  • A page tree.
  • A main branch and any open change-request branches.
  • Its own members, plugin overrides, and site settings.

Pages are ordered siblings in the tree. The first top-level page becomes the site's home page. A page's site path is derived from its title and ancestry, with numeric suffixes added when two pages would otherwise share a path.

Create and organize content

Organization owners and admins can create spaces. Space admins can change space settings and manage its members.

Use the page tree to:

  • Create sibling pages and child pages.
  • Rename pages.
  • Duplicate pages.
  • Move pages between parents.
  • Delete pages, with an option to restore recently deleted pages from the revision they belonged to.

Keep the tree intentional. It drives both editor navigation and the published site's sidebar and previous/next links.

Edit safely

Spaces open on main in read-only mode. Select Edit to begin writing. When the change-requests workflow is enabled, the first edit opens a draft change request on a separate branch. Your work is not committed directly to main.

The editor supports:

  • Headings up to level six.
  • Ordered, unordered, and task lists.
  • Blockquotes.
  • Fenced and indented code.
  • Tables.
  • Links and images.
  • Thematic breaks.
  • Mermaid diagrams when the Mermaid plugin is enabled for the space.

Use the toolbar, slash menu, or Markdown-like input shortcuts to add blocks. The block settings panel controls block-specific options such as heading level, list style, table size, and image source.

Find content

Open the command palette with Command-K on macOS or Ctrl-K on other platforms. It provides navigation commands and page search.

Search is scoped to the current organization or space where applicable. Site search is built from the active publication, so a page must be merged into main and published before visitors can find it.

Collaborate in real time

When the collaboration plugin is enabled, multiple people can edit the same page and branch. Participant carets identify active editors. Docleus commits collaborative state when the document becomes idle, when a participant saves, when the last participant leaves, and before a merge or rebase.

Collaboration is scoped to a branch. Two people editing different change requests are working in separate branches; merge review is where those changes come together.

Inline comment threads are not part of 0.1.0. Use a change request's description and review view for discussion and approval context.

Content portability

Docleus stores pages as versioned block trees. Unchanged Markdown retains its original source slices through import and export. A block from a disabled or removed plugin remains in storage and appears as a read-only placeholder until that plugin is enabled again.

The core includes Markdown directory import and export codecs, but 0.1.0 does not expose a general bulk-import screen in the editor. Treat directory import as an integration or automation task for now.

Limits to know

  • Every page belongs to one space and one page tree.
  • Sites read main; draft branches are never served publicly.
  • The plugin SDK is experimental before 1.0.
  • Git Sync and collections are planned, not available in 0.1.0.