Skip to content

Release 0.3.1 - Documentation Improvements

Choose a tag to compare

View all tags
@gerchowl gerchowl released this 10 Nov 14:49
· 30 commits to main since this release
0.3.1
39f4bbd

Release 0.3.1

Documentation improvements and minor fixes following the 0.3.0 release.

Documentation Improvements

  • Comprehensive README Rewrite

    • User-focused content explaining what the template can do
    • Complete build system documentation with all make targets
    • Project structure and workflow explanations
    • Diagram creation and customization guides

  • Clear Requirements Section

    • Docker Desktop setup instructions
    • Podman Desktop and Podman CLI options
    • Clarified podman machine requirements by platform
    • VS Code and Dev Containers extension requirements

  • Improved Quick Start Guide

    • Step 1: Start container runtime (platform-specific)
    • Step 2: Open in devcontainer with detailed instructions
    • Step 3: Build documentation
    • Step 4: View results
    • Now much clearer for new users

Fixes

  • Project Structure Paths

    • Corrected all references to use docs/main.typ (not technical-documentation/technical-documentation.typ)
    • Fixed diagram paths to docs/diagrams/
    • Updated project structure diagram
    • Aligned documentation with actual Makefile configuration

  • Devcontainer Git Signing

    • Fixed SSH agent integration for git commit/tag signing
    • Works correctly for all users with SSH agent forwarding
    • More secure (private keys never leave host machine)

Additional Changes

  • Removed redundant docs/README.md (merged into main README)
  • Fixed duplicate heading issues
  • Improved Tips section
  • Better platform-specific instructions

This is a documentation-only release building on 0.3.0. No functional changes to the build system or template features.

See CHANGELOG.md for complete 0.3.0 feature details.

Assets 2
Loading