Upgrading

This article highlights notable authoring and presentation changes by release so you can plan upgrades and review any customizations that might need attention.

Changes in 4.0

AI-Assisted Documentation

Version 4.0 adds AI-assisted documentation workflows to help your team find answers, draft revisions, reorganize content, and prepare updates more quickly.

The focus is on helping people maintain documentation, not replacing human review. AI works best when you use it to improve a single article or section at a time and then verify the final wording before you publish it.

Tip

AI assistance still follows your normal permissions and version rules. Unpublished versions are ideal for drafting, and locked versions remain protected from further edits.

Tabler Icons

Version 4.0 switches Rockumentation's built-in icons from Font Awesome to Tabler. This usually requires no action on the admin site, but if your Rockumentation books are viewed on an external website, make sure your site theme also loads Tabler icons or some book-view icons may not render.

Changes in 2.0

New Editor

The major feature in version 2.0 is the Structured Editor. It is similar to Rock's structured editor for content channels, but it includes Rockumentation-specific behavior for documentation authoring.

The Structured Editor makes it easier for teams to create articles quickly without requiring everyone to learn Markdown. It is not a full WYSIWYG editor, but it is familiar enough that most users can become productive quickly.

It's worth noting that the new editor will only be used for new books that you create after installing version 2.0 of the plugin. Old books will by default continue to use the legacy Markdown editor. If you edit an existing book you can change the editor being used from Markdown to Structured Editor. When you save it will confirm the change and then convert all the existing articles. And by convert we mean you can use the structured editor and existing content will be placed inside a single Markdown block.

If you plan to move existing Markdown books to the Structured Editor, consider creating a temporary book first so you can practice with the editor before converting production content.

Video Embeds

This version also adds support for embedding YouTube and Vimeo videos (as well as links to plain MP4 videos) into your articles. However, you must use the new Structured Editor to enable this feature.