docs: sync documentation with codebase after 50+ merged PRs#973
Open
yasinBursali wants to merge 1 commit intoLight-Heart-Labs:mainfrom
Open
docs: sync documentation with codebase after 50+ merged PRs#973yasinBursali wants to merge 1 commit intoLight-Heart-Labs:mainfrom
yasinBursali wants to merge 1 commit intoLight-Heart-Labs:mainfrom
Conversation
Fix stale, contradictory, and missing documentation identified by a systematic audit of the last 50 merged PRs against all existing docs. Fixes: - WINDOWS-QUICKSTART.md: remove "Coming Soon" language, add real install flow, commands, and verified installer flags - MODE-SWITCH.md: add lemonade mode section (auto-configured on AMD) - QUICKSTART.md / README.md: update all Qwen2.5 model names to Qwen3.5/Qwen3 to match current tier-map.sh - POST-INSTALL-CHECKLIST.md: rewrite skeleton with real verification commands - Root README.md: fix Apple Silicon "4B" → "9B" for 16-24GB tier Additions: - SECURITY.md: DREAM_AGENT_BIND / LAN access section - FAQ.md: backup/restore, service templates, bootstrap fast-start, expanded update/rollback documentation - HOST-AGENT-API.md: Windows platform limitation note - CATALOG.md: add missing Langfuse entry - Langfuse README.md: new service README with full configuration, env vars, volumes, and troubleshooting - .env.example: document LLAMA_CPU_LIMIT for macOS/CPU-only mode - SUPPORT-MATRIX.md: link to AMD system-tuning guide Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Lightheartdevs
approved these changes
Apr 18, 2026
Collaborator
Lightheartdevs
left a comment
Lightheartdevs
left a comment
There was a problem hiding this comment.
Spot-checked three claims against source:
- Qwen3.5 tier names match
installers/lib/tier-map.sh✓ - New
langfuse/README.mdports matchmanifest.yaml✓ SECURITY.mddocumentsDREAM_AGENT_BINDwhich is introduced in draft PR #975⚠️
Merge-ordering concern: if #975 ends up being split (as I've recommended there), the DREAM_AGENT_BIND section of SECURITY.md may land referencing code that hasn't shipped yet. Options:
- Merge this after #975's security piece lands, or
- Drop the
DREAM_AGENT_BINDparagraph from this PR and reintroduce it with #975.
Otherwise the docs are clean and the "Opus-level critique pass" claim holds up on the samples I checked. Approving on the condition above.
This was referenced Apr 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Systematic audit of the last 50 merged PRs against all existing documentation revealed stale, contradictory, and missing docs. This PR fixes them:
dream.ps1commands, and accurate installer flagsdream modetier-map.shDREAM_AGENT_BIND/ LAN access documentation with platform defaultsLLAMA_CPU_LIMITfor macOS/CPU-only modeEvery claim was verified against source code by an Opus-level critique pass (tier-map.sh, dream-cli, install-windows.ps1, dream.ps1, dream-host-agent.py, compose files, manifests).
Test plan
installers/lib/tier-map.shdocs/MODE-SWITCH.mdlemonade section matchesinstallers/phases/06-directories.shbehaviorWINDOWS-QUICKSTART.mdinstaller flags matchinstall-windows.ps1param blockextensions/services/langfuse/README.mdports matchmanifest.yaml🤖 Generated with Claude Code