Docs /Docsmith

Docsmith Changelog

Docsmith Changelog

All notable changes to the Docsmith add-on for ExpressionEngine. Newest first.

0.1.19 (2026-11-18)

Fixes

  • Installing or updating Docsmith on MySQL 5.7 or 8 no longer fails with a SQL syntax error near IF NOT EXISTS audience. Docsmith now checks for a column before adding it, which works on both MySQL and MariaDB. Sites left half-installed by the error can run the install or update again.

0.1.18 (2026-11-16)

Licensing

  • Docsmith now checks its license through ExpressionEngine's add-on licensing. On a production site without a valid license, every Docsmith control panel screen shows a notice: a 14-day countdown at first, then a standing notice until a license key is added. Nothing is disabled at any point. Development hosts never show it. See Licensing in docs/INSTALL.md.
  • The install package now includes the license terms at docs/LICENSE.md.

0.1.17 (2026-11-15)

Roadmap

  • Each library can now have a roadmap page at /roadmap, the changelog's counterpart for work that hasn't shipped. It lists each draft version that has roadmap notes, in version order, followed by the library's own roadmap text from the Settings tab.
  • Versions have a new Roadmap notes field. A draft only appears on the roadmap once it has roadmap notes, so draft version names stay private until you choose to list them.
  • When you release a version, it leaves the roadmap. If it has no release notes yet, the release screen starts them from its roadmap notes.
  • New template support: the {exp:docsmith:roadmap} tag, has_roadmap, roadmap_url and is_roadmap_page on the page tag, and has_roadmap and roadmap_url on {exp:docsmith:library}.
  • The roadmap gets a Roadmap link in navigation, a footer link in the starter layout, a table of contents and search indexing. Rebuild Stale Rendered Content now covers roadmaps too.

Other changes

  • The control panel's built-in documentation is rewritten for the library tabs, the version workflow and releases, snippet overrides, and the license, changelog and roadmap pages.
  • The install package now includes this changelog at docs/CHANGELOG.md, next to INSTALL.md.
  • Refreshed the add-on icon.

Upgrade notes

  • Adds an exp_docsmith_library_roadmaps table and a roadmap_notes column to exp_docsmith_versions. Run the add-on update after installing.
  • Run Refresh Shared Templates to add the Roadmap footer link to the starter layout on existing sites. Sites with their own layout can add {if has_roadmap == "y"}<a href="{roadmap_url}">Roadmap</a>{/if} inside {exp:docsmith:library}.
  • While a library has a roadmap, /roadmap serves the generated roadmap page. A library page with the slug roadmap is hidden until the roadmap is removed, the same as /license and /changelog.

0.1.16 (2026-10-19)

Control panel redesign

  • The library edit screen is now a tabbed screen: Navigation, Pages, Snippets, Versions and Settings. Each tab has its own link, and actions return you to the tab you started from.
  • A version switcher appears on every library tab. Docsmith remembers which version you are working on for each library. If you haven't picked one, it uses the newest draft, or the current version if there are no drafts.
  • The Navigation tab is now a tree with indent and outdent buttons, type icons, public paths and status pills. Pages can now move between sections from the tree. Deleting a row asks for confirmation inline and says how many pages will go with it.
  • The page editor has a settings column with navigation title, slug, parent, status, summary, table of contents, search and hide-from-navigation toggles, and SEO fields. A note warns when a slug or parent change will create a redirect.
  • The snippet editor has the same layout. The settings column shows the snippet reference with a Copy button, its status and scope, and a "Used on" list.
  • The page and snippet editors have a live preview with Write, Split and Preview modes. The preview uses the same renderer as saving.
  • The Versions tab shows current and status pills, URL key, source version, release date and public URL. Release date, outdated-banner text and "make current" are now editable.
  • Groups were restyled with audience cards. URL Base and Included Channels show only when they apply to the chosen audience. Audience labels now read Public site, Control panel, and Site + control panel.
  • Each Settings maintenance action now explains what it changes and what it leaves alone, and returns to Settings when it finishes.
  • Library status (active or inactive) can be changed from the Settings tab.

Versions and releases

  • New Version is now a guided screen. A new version can copy any existing version, start blank with an Overview page, or import Markdown with one page per ## heading. Imports are checked on a confirmation screen before anything is created.
  • New versions start as drafts, so they aren't public while you prepare them. Pages created in a draft version default to Published, so they go live when the version is released.
  • A new Release action shows how many pages will go live, which pages are still drafts, and which pages show missing-snippet warnings. It won't release a version that has no pages. It also asks whether to archive the current version or keep it listed, and pre-fills the outdated-banner text.
  • Each version now has release notes. The library changelog page lists every released version's notes, newest first, followed by the library's own changelog text.
  • A version can override a library-wide or global snippet with its own copy. Other versions keep using the original. Deleting the override switches back to the shared snippet.
  • Archived versions are no longer indexed for search or listed by {exp:docsmith:versions}. They are still reachable by URL and show their outdated banner.
  • Links inserted while editing a non-current version now follow the current version instead of being pinned to the version you were editing.

Fixes

  • Success and error messages in the control panel now display. Previously none were shown.
  • Saving a nested page without changes no longer changes its URL or creates a redirect.
  • Missing-snippet warnings now render as callouts instead of escaped HTML tags.
  • Deleting a version now also deletes that version's own snippets.
  • Release dates are stored correctly. The date was previously saved as just the year.
  • Dark mode in the control panel: select arrows, input backgrounds, buttons and rendered Markdown now follow the EE theme.
  • The publish tab's table of contents now links correctly and no longer shows the # anchor character.
  • Dashboard search and the status filter no longer go to a 404. The Library list has the same filter.
  • Cancelling the global snippet form no longer goes to a 404.
  • Rendered Markdown in the editors and preview screens is now styled.
  • The "Check the pages" import screen no longer shows the pasted Markdown in a box above the page list.

Upgrade notes

  • Adds a release_notes column to exp_docsmith_versions. Run the add-on update after installing.

0.1.15 (2026-09-11)

  • Pages and Navigation tables in the control panel now have a Delete action on each row, with a browser confirmation.
  • Fixed a packaging bug where rebuilding a version kept files that had since been deleted. Upgrading from an earlier zip may have left stale files behind.
  • The release build now refuses to run when the requested version doesn't match the version the add-on reports to EE.
  • Internal development notes are no longer included in the package.
  • Removed two duplicate files: docsmith-icon.svg and javascript/code-copy.js.

0.1.14 (2026-08-26)

  • Libraries can have an optional Changelog, managed from the library edit screen. When it has content, Docsmith serves a /changelog page for the library.
  • Added the {exp:docsmith:changelog} tag, plus has_changelog, changelog_url and is_changelog_page variables on the page tag, and a Changelog link in navigation.
  • {exp:docsmith:library} now exposes has_license, license_url, has_changelog and changelog_url.
  • The starter layout footer is now a multi-link bar. Before, it was hidden entirely for libraries with a changelog but no license.
  • Changelog content is indexed for search and rebuilt along with other stale content.
  • /license and /changelog now fall back to a normal page with that slug when no generated document exists, instead of returning a 404.

0.1.13 (2026-08-16)

  • Licenses now belong to the library rather than individual pages. The License panel is on the library edit screen.
  • Fixed the starter layout footer.

0.1.12 (2026-08-16)

  • Added View License links in the control panel license panel and the starter article template.

0.1.11 (2026-08-15)

  • Moved License Markdown editing out of page forms and into a panel on the library edit screen.

0.1.10 (2026-08-15)

  • Added optional License Markdown. When it has content, Docsmith serves a /license page.
  • Added license template variables, the {exp:docsmith:license} tag, navigation links, and search indexing for license content.

0.1.9 (2026-08-08)

  • The control panel Documentation page is now a single-column article. It covers previewing, audiences and the publish tab.
  • Expanded the packaged docs/INSTALL.md.

0.1.8 (2026-08-08)

  • Fixed the publish tab label casing to "Docsmith".

0.1.7 (2026-08-08)

  • Headings written without a space after the hashes, such as ###Requirements, now render as headings. Stored Markdown is not rewritten.
  • The publish tab now checks whether stored HTML is up to date instead of guessing from its content.
  • Stale rendered content is rebuilt automatically when the add-on is updated.

0.1.6 (2026-08-08)

  • The publish tab renders Markdown with snippets when stored HTML is missing.

0.1.5 (2026-08-08)

  • Internal cleanup in the publish tab. No visible changes.

0.1.4 (2026-08-08)

  • The publish tab is now a full documentation reader with navigation, articles and a table of contents. It shows only visible, active libraries with published pages.

0.1.3 (2026-08-08)

  • Publish tab links now open the published documentation instead of the library edit screen.

0.1.2 (2026-08-08)

  • The publish tab shows linked documentation as formatted HTML instead of a read-only text field.

0.1.1 (2026-08-08)

  • Groups can be linked to channels with Included Channels.
  • Linked channels get a Docsmith tab on their publish and edit screens, showing the group's documentation inside the control panel.

0.1.0 (2026-08-08)

First release.

  • Markdown documentation libraries with versions, navigation trees, pages and redirects.
  • Groups that collect several libraries under one documentation portal URL.
  • Reusable snippets inserted with Missing snippet: short-name, scoped globally, to a library, or to a version.
  • Markdown rendering with callouts, code highlighting, copy buttons and a table of contents.
  • Per-library and per-group search.
  • Starter frontend templates in a shared docsmith template group, with theme CSS and JavaScript in themes/user/docsmith.
  • Template tags for libraries, groups, pages, navigation, versions, breadcrumbs, table of contents, previous/next links, snippets and search.
  • Import Markdown to create one page per ## heading.
  • Control panel dashboard, library and snippet management.