Skip to content

docs(architecture): delete Known gaps that v2.0.3 closed - #2014

Merged
MODSetter merged 1 commit into
devfrom
docs/delete-stale-known-gaps
Sep 28, 2026
Merged

MODSetter merged 1 commit into
devfrom
docs/delete-stale-known-gaps

Conversation

@MODSetter

@MODSetter MODSetter commented Sep 28, 2026 •

Copy link
Copy Markdown
Owner

What

Deletes five Known gaps lines that are no longer true, rewrites a sixth that was only half true, and updates the roadmap bullet that asserted the same stale facts.

docs/architecture/packaging.md — four lines deleted:

  • build-sdcpp.yml having never run
  • no tagged release having built the llama.cpp runtime
  • no release having built or packaged audio.cpp, and nothing having staged its macOS archive on a Mac
  • no workflow running the surfsense_local unit or integration tests on pull requests

docs/architecture/updates.md — one line deleted: the --repo fix to legacy-update-bridge never having run on a tag.

docs/architecture/local-models/fit.md — one line rewritten rather than deleted. The Windows half is fixed; the Device.reports_live_memory half is not, so the line now says only what is still true, plus the missing test.

docs/ROADMAP.md — "Release and CI health" said the next release would be the first to carry the llama.cpp runtime. It now describes what v2.0.3 shipped and what CI work is genuinely left.

Why

The v2.0.3 release on 26 Sep 2026 closed most of these, and nothing deleted the lines. Run 36250362768 on tag v2.0.3 was green on all eight jobs — sdcpp / Linux x64, sdcpp / macOS arm64, audiocpp / Linux x64, audiocpp / Windows x64, the three build jobs and legacy-update-bridge — which settles the four packaging lines and the updates line between them. The macOS audio.cpp staging is covered because release-local.yml runs scripts/audiocpp/stage.mjs --strict on every runner and skips only the artifact download on macOS, where upstream's archive is fetched instead.

The CI line was already false before that: desktop-tests.yml triggers on pull_request into main and dev and runs uv run pytest -m unit, uv run pytest -m integration and pnpm test.

The fit.md line was fixed by aaa461fc9, "fix(local): read free memory on Windows" (24 Sep), which gave system_memory.available_bytes() a win32 branch calling GlobalMemoryStatusEx. Device.reports_live_memory is still read nowhere — devices.py:40 is its only occurrence — so that half stays, and available_bytes() having no test is worth recording while the line is open.

This matters beyond tidiness: CONTRIBUTING.md and all ten READMEs point contributors at the Known gaps lists as a place to find work, so a stale line sends someone to fix something that already works.

Fixes #

How to test

python scripts/check_docs.py

96 doc files, 0 problems. Docs only, no code touched.

To confirm the claims rather than take them on trust:

gh run view 36250362768 --repo MODSetter/SurfSense   # eight jobs, all green, on tag v2.0.3
git log -1 aaa461fc9                                  # the Windows free-memory fix
git grep -n reports_live_memory -- surfsense_local    # one hit: the definition

High-level PR Summary

This PR removes outdated documentation about known gaps and issues that were resolved in release v2.0.3. Specifically, it cleans up statements about CI workflows that now run successfully, runtime builds that are now working, and features that have been fixed. The changes update the roadmap to reflect what v2.0.3 actually shipped and rewrites one partially-resolved item about Windows memory reporting to only mention the part that remains unfixed.

⏱️ Estimated Review Time: 5-15 minutes

💡 Review Order Suggestion
Order File Path
1 docs/ROADMAP.md
2 docs/architecture/packaging.md
3 docs/architecture/updates.md
4 docs/architecture/local-models/fit.md

Need help? Join our Discord

The v2.0.3 release built and packaged llama.cpp, sd.cpp and audio.cpp on all three runners, and legacy-update-bridge ran on the tag, which settles four packaging lines and one updates line. desktop-tests.yml already ran the surfsense_local tests on pull requests. The fit.md line is rewritten, not deleted: aaa461f fixed the Windows reading, but Device.reports_live_memory is still read nowhere.

Co-authored-by: Cursor <cursoragent@cursor.com>
@vercel

vercel Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
surf-sense-frontend Ready Ready Preview Sep 28, 2026 11:04pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 28, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: ce43a944-75d4-4672-b62b-223d6020f662

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@MODSetter
MODSetter merged commit 4a9dc14 into dev Sep 28, 2026
18 of 19 checks passed

This branch was successfully deployed

1 active deployment
Preview — 35eca956 Deployed Sep 28, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant