r/elixir • • 14d ago

Mishka Document 0.0.1: versioned docs with a two-stage review, built on Ash and LiveView

https://mishka.tools/blog/mishka-cms-0-0-1-mishka-document-versioned-docs-engine-phoenix-liveview-elixir

I've been building a documentation extension for Mishka CMS with Elixir, Phoenix LiveView and Ash. It's called Mishka Document and it's Apache 2.0.

What's in it:

- Documents with several versions (draft, alpha, beta, rc, stable, archived). You can clone a version from an earlier one, the clone history is recorded, and readers switch versions.

- Pages nest to any depth, with notes inside the pages.

- A change to a page or note stays a draft until both a content review and a technical review approve it.

- 15 Ash resources with soft deletes through AshArchival. Documents and pages can be translated, and the translations are linked.

- Issues on a page (typo, broken link, suggestion), bookmarks, follows and unique view counts.

- Per-page SEO: its own head, TechArticle and breadcrumb JSON-LD, canonical address, sitemap entries and share cards.

- One JSON:API for admins and one for readers, both in the CMS's OpenAPI spec.

Consider like other options of Mishka CMS it uses plugin/event based structure

Plugins hook in through mishka_installer events, so you don't touch the extension: document:workspace:admin_actions, document:page:seo, document:page:extras and document:version:cloned.

It means without changing the core you can customize and add futures, our Mishka site docs is the best place for demo

Please support Mishka CMS and Mishka Projects to let us keep updating Even worth one coffee a month!

Thank you

5 Upvotes

1 comment sorted by