Mucklet Docs

The public documentation and release-notes site for Mucklet.

It is built with Hugo and the Docsy theme. The first published content area is Releases.

Local development

Prerequisites:

• Hugo Extended 0.160.1 or newer
• Node.js and npm

Install the generated Docsy frontend dependencies, then start the development server:

npm ci
hugo server --environment development

Open http://localhost:1313/. In the development environment, the navigation link back to Mucklet points to http://localhost:6460/.

Build the production site with:

hugo --minify --environment production

The generated static files are written to public/.

Content

Release notes live in content/en/releases/, one leaf bundle per release. Keep images used by an entry in that bundle, rather than hotlinking them.

Deployment

The GitHub Actions workflow builds the site on pushes to main and deploys it when these repository secrets are configured:

• DOCS_DEPLOY_HOST
• DOCS_DEPLOY_USER
• DOCS_DEPLOY_SSH_KEY
• DOCS_DEPLOY_KNOWN_HOSTS

The remote host should expose /srv/auth/docs/current through the docs service defined in the Chartales deployment repository. The workflow uploads each build to a release directory and atomically switches the current symlink.