Manuals

Manuals

Manuals let you create structured operational guides, training handbooks, and standard operating procedures (SOPs) inside Omoplata. Documents are organized into guides, each consisting of one or more sections. The built-in editor auto-saves your work so you never lose a draft.

Permissions

You need the "see guides" permission to view manuals. Creating, editing, and publishing guides requires the "manage guides" permission, which is assigned to admins by default.


Creating a guide

  1. Navigate to Manuals in the main navigation.
  2. Click Create Guide in the top right. A new untitled guide is created immediately and you are taken to the guide page.
  3. Click on the title area to name your guide. You can also add an emoji icon and a short description.
  4. Use Add section in the table of contents sidebar to add your first section.

Guides start as drafts and are only visible to you until you publish them.


The editor

Each section has its own editing page. Click a section in the table of contents to open it.

The editor supports rich content including headings, bullet and numbered lists, checklists, tables, block quotes, dividers, and images. Use the / slash command menu to insert any block type. You can also drag blocks to reorder them.

Auto-save

The editor saves automatically every 10 seconds. A status indicator in the top bar shows the current state:

  • Saving... -- a save is in progress.
  • Saved 2 minutes ago -- the last successful save.
  • Unsaved changes -- there are changes that have not yet been sent to the server.

Changes are also saved when you navigate away from the page, so you do not need to manually save before switching sections. You can also press Cmd/Ctrl + S at any time to save immediately.


Sections and nesting

Guides support one level of section nesting. You can create top-level sections and sub-sections within them. This keeps navigation manageable without becoming overly complex.

Sections can be reordered and nested using drag-and-drop on the guide overview page. Drag a section over another to nest it as a sub-section; drag it to the top or bottom edge of a section to reorder it.

Sections include Previous and Next navigation links at the bottom for a linear reading experience.


Publishing a guide

A draft guide is only accessible to admins. When your guide is ready to share with your team:

  1. Open the guide and click Publish in the top bar.
  2. The guide status changes to Published and becomes visible to the roles you have configured in the guide's visibility settings.

You can Unpublish a guide at any time to revert it to draft status.


Visibility settings

Each guide can be restricted to specific roles. Open the guide Settings (gear icon in the top bar) and select which roles can see the guide. If no roles are selected, the guide is visible to all roles.

Common visibility configurations:

  • Admins only -- Internal management docs, financial SOPs, staff procedures.
  • Admins + coaches/trainers -- Teaching guides, class curriculum, warm-up protocols.
  • All members -- Club rules, code of conduct, safety guidelines.

Linking guides to classes and disciplines

Guides can be linked to specific classes or disciplines so they are easy to find in context. In the guide Settings modal, scroll to Linked Classes & Disciplines to add or remove links.

Linked guides can be referenced from the occurrence edit modal -- coaches can copy a guide section directly into an occurrence's planned content field.


Sharing a guide publicly

You can generate a public share link for a guide that allows anyone with the link to view it without logging in. This is useful for sharing club rules, visitor information, or curriculum documents with prospective members or external coaches.

To create a share link:

  1. Open the guide and click the Settings icon.
  2. Under Share Link, click Create Share Link.
  3. Copy the generated URL and share it.

Only published guides are accessible via a share link. You can revoke the link at any time from the same Settings panel, which immediately invalidates all existing links.


Searching guides

The manuals index page includes a search bar that searches across guide titles, descriptions, section titles, and section content. Use it to quickly locate documentation across all your guides.

Each guide also has a section search in the table of contents sidebar, which filters sections as you type.


Checklist support

The editor supports interactive checklists (inserted via the / menu). Checklists are useful for pre-class preparation tasks, opening/closing procedures, or safety protocols. In the read-only view, checkboxes are functional so readers can tick items off as they complete them.

When a guide section with a checklist is copied into an occurrence's planned content, all checkboxes are automatically reset to unchecked so the list is ready for each session.

Was this page helpful?

Previous
Orders