Skip to content

v3.1.0 — Diataxis Documentation Site

Choose a tag to compare

View all tags
@virtualian virtualian released this 29 Mar 02:06
· 5 commits to main since this release
v3.1.0
4631e2f
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

What's New

Restructured documentation into a full Diataxis site with three audience roles and four content types.

Documentation Structure

Role Tutorials How-To Reference Explanation
Developer (primary) 3 3 3 3
Maintainer — 1 1 1
Contributor — 1 1 —

Developer docs follow a learning progression: online-first → online-with-sync → offline-first across all content types.

Site Improvements

  • Search across all docs (Docsify search plugin)
  • Copy-to-clipboard on code blocks
  • Improved theme with better typography, table styling, and blockquote callouts
  • YAML and JSON syntax highlighting added
  • CSS custom properties for single-source theming

Content

  • 17 new documentation files derived from codebase and existing docs
  • Deduplicated content with cross-links to canonical reference files
  • Mermaid diagrams for architecture and data flow visualization

Full Changelog: v3.0.0...v3.1.0

Assets 2
Loading