You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[guide] README says C++ engine still in src/ (removed by ADR-0021); AGENTS.md and crates.md count two unsafe crates, ADR-0019 says three #385
Two statements in the docs no longer match the tree at 3bc2b7f.
README.md:209-210 says: "The original C++/Qt engine is still in src/ as a behavioural reference. It is not built into any Compass package." ADR-0021 (accepted 2026-09-25) removed the C++ tree. Today src/ holds only src/typescript, and no *.cpp, *.hpp or CMakeLists.txt file is left. CONTRIBUTING.md:36 and AGENTS.md:3 already say the C++ engine is gone and that upstream Vicinae releases are the reference. A reader who follows the README looks for a reference engine that is not there.
The unsafe exceptions are counted as two in AGENTS.md:21 and docs/crates.md:37,62. The real count is three.AGENTS.md says "The only exceptions are compass-sqlcipher-sys and compass-wayland-foreign". crates.md calls them "One of the two crates allowed unsafe" and "The other crate allowed unsafe". ADR-0019 (lines 7-9 and 60) lists a third crate, compass-wayland-protocols, which carries generated interface tables. Its Cargo.toml opts out of [lints] workspace = true and sets unsafe_code = "deny", and src/lib.rs puts #[allow(unsafe_code)] on the generated modules. README.md:61-63 already says "three small binding crates".
Recommendation
README.md: replace the "still in src/" sentence. Say the C++ engine was removed (ADR-0021) and that the pinned upstream Vicinae release is now the behavioural reference.
AGENTS.md: name all three crates that opt out of the workspace unsafe_code lint, and say what each one is for, following ADR-0019.
docs/crates.md: list compass-wayland-protocols as one of the three crates allowed unsafe, and fix the "two crates" wording on the two existing rows.
Evidence: ls src returns only typescript. grep -L 'workspace = true' crates/*/Cargo.toml returns sqlcipher-sys, wayland-protocols and wayland-foreign (via their lints sections). grep -n 'three\|protocols' docs/rust-engine/adr/0019-*.md shows the third crate. Dedup: gh search issues and gh search prs on tuna-os/compass returned no matches. Policy: the ruling on tuna-os/blueshell#220 sends compass's stale-doc instances to ordinary per-repo PRs.
Activity