How to use OpsLab Books¶

Welcome! This is the one page that explains the whole platform. Read it top to bottom and you'll know everything you need to write and share documentation — no technical knowledge required.

What this is¶

OpsLab Books is a place to write and publish documentation. The mental model is a bookshelf:

• A book is one set of docs (e.g. "Customer Handbook" or "API Guide").
• A page is one article inside a book.
• A section is a folder that groups related pages.

Everything you write is saved as plain text on the server, so your content is always yours and never locked into a weird format.

1. Create a book¶

1. Go to your Dashboard.
2. Click New book.
3. Give it a name and a short description. Done — you've got an empty book.

2. Write a page¶

Open your book and click New page. You'll land in the editor. There are two ways to write, and you can mix them freely:

The block editor (easiest). Just start typing. Press Enter for a new block, or click the + to add a heading, list, image, quote, code block, or callout. It works like any modern doc tool — no special syntax to learn.

Markdown (if you like it). If you already know Markdown, type it directly and the page renders it. # Heading, **bold**, - list item, fenced code blocks, and tables all work.

Your work saves as you go. When you're happy, the page is live.

3. Organise as it grows¶

A handful of pages can just sit in a flat list. Once you have more, group them:

• Create a section to act as a folder (e.g. "Getting started", "Troubleshooting").
• Drag pages in and out of sections in the sidebar to reorder them.
• You can nest sections a few levels deep if you really need to — but flatter is usually easier to read.

4. Link pages together¶

Inside any page you can link to another page in the same book. The editor lets you pick the target from a list, so you don't have to copy URLs. Bonus: each page shows its backlinks — every other page that points to it — so readers can find their way around.

5. Find things fast¶

• Search — the search box at the top searches every page in the book.
• Command palette — press Ctrl/Cmd + K to jump to any page by name without touching the mouse.

6. Undo mistakes¶

Every page keeps a version history. If you break something or want to see an earlier draft, open the page's history and restore any previous version. Nothing you write is ever truly lost.

7. Share your docs¶

You have a few options, depending on who should see it:

• Send the link. Every page has a normal web link you can paste anywhere.
• Export the book. Download the whole book to keep or hand off.
• Publish on your own web address. Make a book live at something like docs.yourcompany.com instead of a link on this site. See Publish on your own domain for the step-by-step (add the address → add one DNS record → verify).

Common questions¶

Do I need to know Markdown? No. The block editor handles everything. Markdown is there if you prefer it.

Where does my writing go? It's saved on the server as plain text the moment you write it. There's no "publish" button to forget — pages are live as you edit.

I messed up a page. Can I get the old one back? Yes — open the page's version history and restore an earlier version.

Can I have more than one book? Yes, as many as you need. Each is independent.

Something looks wrong / I'm stuck. Open the full User Guide from the top bar, or contact your administrator.

That's the whole platform. The fastest way to learn it is to create a throwaway book and play for five minutes — you won't break anything, and version history has your back.