Skip to content

Local DE Coach v0.4.0 — Live Docs Site + Comprehensive README

Choose a tag to compare

View all tags
@bif26 bif26 released this 12 Sep 22:49
· 13 commits to main since this release
v0.4.0
d23ce78

📚 Live documentation site

The 33-page architecture PDF is now also available as a Docusaurus-style web UI at:

https://bif26.github.io/Local_DE_Coach/ (once you enable Pages — see below)

✨ What's new

docs-site/ — Interactive docs web UI

  • 20 chapters (cover + 19) as interactive HTML, not a PDF viewer
  • Left sidebar: chapter navigation grouped by section (Overview / Architecture / Pipeline / Scoring / Persistence / API / Operations / Roadmap)
  • Right sidebar: 'On this page' TOC with scroll-spy highlighting
  • Top bar: search (⌘K) with live results, dark/light theme toggle, GitHub link
  • Mobile responsive: collapsible sidebar, hidden TOC on tablet
  • Vanilla JS + CSS — no build step, no framework dependency
  • .nojekyll bypasses Jekyll processing on Pages
  • Auto-syntax highlighting for code blocks (Python-style)

Comprehensive README rewrite

  • Features section covering all 8 capability areas (Core, Practice Modes, SRS, Persistence, Controller, Auto-Recovery, Web UI, Smart Setup, Docs)
  • Architecture diagram (controller + backend two-tier)
  • All setup modes documented (7 modes)
  • Full API reference (controller + backend endpoints)
  • Scoring layers table, RAM budget table
  • Releases table linking to all 5 versions
  • Links to live docs site, latest release, repository

📖 How to enable GitHub Pages (one-time, 30 seconds)

The current PAT doesn't have the pages scope to do this via API. To enable:

  1. Go to https://github.com/bif26/Local_DE_Coach/settings/pages
  2. Under Build and deployment → Source, select Deploy from a branch
  3. Under Branch, select main and /docs-site folder
  4. Click Save
  5. Wait ~30 seconds, then visit https://bif26.github.io/Local_DE_Coach/

The docs site is built with vanilla HTML/CSS/JS — no build step required, so Pages will serve it immediately.

📋 What's in the docs site

Section Chapters
Front Matter Cover
Overview Executive Summary, Problem Analysis, Core Principles
Architecture Project Structure, Hardware & RAM Budget
Pipeline Audio Preprocessing, ASR Engine
Scoring Multi-Layer Scorer, Adaptive Levels, Exam Alignment
Persistence SQLite Schema, SRS
API API Spec, System Monitor
Operations Workflow, Dependencies, Deployment
Roadmap Testing, Implementation Roadmap

📄 Note on GitHub Actions auto-deploy

I drafted a .github/workflows/deploy-docs.yml for auto-deploy on push, but the current PAT doesn't have the workflow scope to push workflow files. Once you rotate the token with workflow + pages scopes, I can add the workflow in a follow-up commit. Until then, the branch-based Pages deployment above works perfectly — Pages serves from main / docs-site on every push.

Full changelog: see git log v0.3.0..v0.4.0

Assets 3
Loading