Skip to content
Authors: Luke Boening, GitHub Co-Pilot, Claude Sonnet 4.5 • Last update: December 14, 2025 03:38:37 • 2 min read

Release

Using the Documentation Release

Note: You will need access to the private GitHub repo to download a release

If you want a complete copy of this documentation without installing Python or any development tools, you can download a pre-built release from GitHub.

Quick Start - No Installation Required

Step 1: Download the Release

  1. Go to the GitHub repository: https://github.com/lboening/boening.us
  2. Click on "Releases" (right sidebar)
  3. Find the latest release (e.g., v0.2.0)
  4. Download the boening-us-docs-v0.2.0.zip file

Step 2: Extract the Archive

Windows:

  • Right-click the downloaded zip file
  • Select "Extract All..."
  • Choose a destination folder
  • Click "Extract"

macOS:

  • Double-click the zip file
  • Finder automatically extracts it

Linux:

unzip boening-us-docs-v0.2.0.zip -d boening-docs
cd boening-docs

Step 3: View the Documentation

Option A: Local Viewing (Offline)
  • Navigate to the extracted folder
  • Double-click index.html
  • Your default browser opens the documentation
  • Browse offline without internet connection
Option B: Deploy to Web Server
  • Upload all extracted files to your web server

  • Example structure on server:

    /var/www/html/docs/
    ├── index.html
    ├── about/
    ├── css/
    ├── js/
    └── ...

  • Access via https://yourdomain.com/docs/

What's Included

The release zip contains:

  • ✅ Complete HTML documentation (no build needed)
  • ✅ All CSS styling and themes
  • ✅ JavaScript for search functionality
  • ✅ Images and assets
  • ✅ Fully functional navigation
  • ✅ Offline-capable

No Installation Needed

Unlike working with the source repository, the release requires:

  • ❌ No Python
  • ❌ No MkDocs
  • ❌ No build process
  • ❌ No dependencies

Just extract and view!

Use Cases

Personal Archive:

  • Keep documentation offline on your computer
  • Browse without internet connection
  • Archive specific versions for reference

Internal Distribution:

  • Share with team members who need read-only access
  • No GitHub account required
  • Extract to shared network drive

Web Deployment:

  • Upload to any web host (Apache, Nginx, IIS)
  • Serve as static HTML
  • Fast loading, no server-side processing needed

Version Management:

  • Download multiple releases for comparison
  • Keep historical versions archived
  • Each release is self-contained

Updating to New Release

  1. Download the new release zip
  2. Delete old extracted folder (or rename for backup)
  3. Extract new release
  4. Continue using - all links and navigation work immediately

Limitations

The pre-built release is read-only. You cannot:

  • Edit markdown files
  • Rebuild with changes
  • Update document statistics
  • Run front matter checks

For editing and contributing, you need the full development setup (see repository README).

Release Versioning

Releases follow semantic versioning:

  • v0.2.0 - Initial release
  • v0.3.0 - Minor updates
  • v1.0.0 - Major milestone

Check the release notes for what changed in each version.

If you want a complete copy of this documentation without installing Python or any development tools, you can download a pre-built release from GitHub.