Skip to content

v0.8.1
Compare
Choose a tag to compare
@FoxxMD FoxxMD released this 17 Jul 17:23
· 181 commits to master since this release
0.8.1
60e880f

What's New?

This release is entirely for documentation and developer experience improvement.

100% Docusaurus and Self-Hosted Docs

While MS was already using Docusaurus for the docs website the prior approach to writing docs was to keep them as plain markdown as possible so they were still accessible without needing access to an external website. With the "plain" markdown docs you could potentially browse from your own markdown reader in a cloned repository.

The downside to this interoperability is that docs, specifically configuration, had grown to be very long and full of nested/too many headers for each iteration of env/file + regular sections for clients/services. Adding additional examples made the problem even worse.

The solution, then, was to make the Docusaurus documentation part of multi-scrobbler! Now the same docs found at https://foxxmd.github.io/multi-scrobbler can also be found at the /docs URL on your multi-scrobbler instance (http://yourHost:9078/docs)

This enabled me to lean fully into Docusaurus and all of the layout, styling, and organization it offers. Alongside general improvements new docs have been added to help onboarding. Some highlights:

  • A Quickstart guide has been added for aiding onboarding
  • Improved readability and usefulness of all content in Configuration docs
    • ENV, File, and all-in-one File configuration has moved to Tabs under each Source/Client
      • Switching config type syncs tabs selection across all sections and in the URL
    • Full configuration examples are displayed for file and AIO-file parsed from the examples in the config directory
  • Improved styling across all docs
    • Copious usage of collapsed sections for examples to make scanning docs easier
    • Improved Table of Contents with only important headings
    • Admonition elements for increasing readability for tips/notes/warnings...
  • Installation docs use Tabs for docker and docker-compose examples
  • Actual development docs and tutorial (!)

And many more...check out the docs site or click on Docs in your MS dashboard to see the updated site.

Flatpak Convenience Setup

A bash script for automating building flatpak from source has been added at flatpak/setup.sh:

  • Removes node_modules and generates sources for flatpak-builder for both MS and the docsite
  • Builds the flatpak app in a given directory

Effectively making flatpak builds a one-line process rather than the manual 7-8 commands it was before.

See flatpak build instructions in the new docs.

Full Changelog

Documentation

  • (feat) Add architecture overview, common dev structures, and dev guidance for Sources
  • (fix) Update package scripts to use npx to invoke docusarus
  • (fix) Add missing docsite build steps to alpine docker variant
  • (flatpak) Implement bash setup script and move flatpak instructions to docsite
  • (No Category) Update docusaurus to v3
  • (No Category) Update docusaurs playground schema for MS to latest
  • (No Category) Improve TOC for docusaurus and github
  • (No Category) Implement self-hosted docs
  • (No Category) Replace manual notes with admonitions
  • (No Category) Lean 100% into docusaurus documentation
  • (No Category) Refactor installation.md for docusaurus
  • (No Category) Update kitchensink.md code block titles
  • (No Category) Parse and render config examples from repository
  • (No Category) Add quick start guide
  • (No Category) Use relative paths for volume mounting
Assets 2
Loading