Before You Start

• Use the Rockumentation page under Installed Plugins to create and manage books and versions.
• If a book uses multiple versions, make sure you are editing the correct version before you start changing content.
• Most article content is edited directly in the book viewer rather than on a separate admin page.
• Edit access lets you update article content, while Administrate access is required for tasks like managing security or child articles.

Creating a Book

To start working on a new documentation book, go to the Installed Plugins page. There you will find the Rockumentation page, which lists current books and lets you create new ones.

To create a new book, click Add in the grid and enter the requested information. If you select an Attachment File Type, the editor can upload images and files to attach to articles. A file type of Unsecured is usually fine, but you can leave the field blank if you do not want article attachments.

A book can use versioning or remain single-version. New books do not enable version support automatically, so turn that option on if you expect to maintain multiple versions. If you start without versioning, you can enable it later by editing the book.

Books are searchable by default. If you do not want a book included in search results, you can disable that option when editing the book.

When you create a new book the system will also automatically create a new version and an initial root article for you. The version will be called 1.0.0. If multi-version support is not enabled, the version is still created but it will be hidden from the UI.

When you are viewing a book, the View Book button takes you to the same reader used for editing. There is no separate article-editing page. If you have permission, you edit content directly in the book view.

Creating a Version

If the book uses versioning, the book detail screen shows all versions in a grid.

You have two options when it comes to creating a new version. You can start with a completely blank and new version if you wish. This is not really recommended as you would be starting over and creating all new content, new article structure, and everything. But if you really want to go this route, you can click the Add button on the grid.

The recommended way to create a new version is to duplicate an existing version - usually the current version. This will create an exact duplicate of all the articles as well as any attached files.

If you want to go this route, simply click on one of the versions in the version list grid to go to the version detail screen.

The button in the bottom right corner allows you to duplicate this version. Once clicked you can specify the new version title as well as mark if it should be published or not.

The version detail screen also includes a View Book button, which is a quick shortcut to opening that specific version in the book viewer.

Editing Articles

As noted earlier, the book viewer is also where you edit content. Once you click View Book, you are in the right place to update article content.

If you have edit access to the article then there will be a dimmed out ti ti-dots-vertical button in the top-right corner of the article. If you click that button a menu wills how up that shows all available commands.

If you also have Administrate access to the article, the action area expands to four buttons. From left to right, they are:

1. Print: Makes it easier to print the article, potentially with child articles all at once.
2. Copy Article Slug: Copies the current article slug so you can link to this article from another article.
3. Edit Article Content: Switches into edit mode to change the content of the article.
4. Article History: Opens a dialog where you can browse the change history for the article.
5. Child Articles: Opens a dialog where you can add, delete, and reorder child articles. Viewing the list requires Edit access, and making changes requires Administrate access.
6. Edit Security: Changes security for this article. This requires Administrate access.

When you click Edit Article, you can update the article content and, if enabled, upload images and documents attached to the article. For more on editing formats and tools, see Structured Editor.

If your team uses AI assistance while authoring or maintaining documentation, see the Using AI Assistance article for practical guidance on where it helps most and what still needs human review.

Linking to Articles

For this example, assume there are four articles: a main root article with two children, Article 1 and Article 2, and then Article 3 as a child of Article 2:

Main Article
  |- Article 1
  \- Article 2
       \- Article 3

When linking to articles, Rockumentation looks for a sibling article first. For example, if you are on Article 1 and link to article-2, it will correctly find Article 2. To link from Article 1 to Article 3, you would use article-2/article-3.

You might expect that, while on Article 2, you would still need to use article-2/article-3 to reach the child article. Normally that would be true, but Rockumentation includes a shortcut for child links. In this case, you can simply use ./article-3.

You can also use absolute paths when linking to articles. For example, if you are several levels deep in the tree and want to link to a root-level article, prefix the path with /. No matter which article the reader is viewing, /article-1 will always point to Article 1. This can be convenient, but absolute paths are more likely to break if you later reorganize your article tree.