docs: scrub internal/private-project references from published docs - #116
Merged
Conversation
Remove references that leaked unpublished sibling projects, local filesystem paths, and agent-process artifacts into the public tree, while preserving the (public) technical substance and all legitimate license attribution: - Private projects genericized: the DST-inspiration project -> 'a cooperative-fiber DST runtime'; the LSM/buffer/replication design sources -> descriptive equivalents (structure-adaptive LSM, Bitcask, JE-style index-in-WAL + cleaner, quorum-systems toolkit). Affected: test/sim/DESIGN.md, DST-V2-DESIGN.md, docs/design/lsm.md, buffer-swip-aio.md, ROADMAP.md, lab/. - Local paths removed: ~/oss/*, /home/gburd/ws/*, /Users/gregburd/*, a /nix/store TCL path, a build worktree path. - Agent-process artifacts removed: the 'agent/test-triage' worktree note and every reference to gitignored .agents/*.md working notes (genericized to 'the test-suite maturity plan' / inline description). - Benchmark hardware genericized (specific bare-metal instance -> 'bare-metal server'). Kept deliberately: the ISC license attribution to libxtc in src/os/os_aio_*.c (proper provenance), and the public hegel-c dependency the PBT tests clone. Comment-only edits to sim_scenario.h / test_sim_crash_recover.c / adaptive.h (no code change); scripts and rank_coverage.py re-verified to parse.
Coccinelle convention checksNo new violations. ✅ Resolved since baseline (2) -- update dist/cocci/baseline.txt to lock these in. |
ABI diff vs
|
gburd
added a commit
that referenced
this pull request
Jul 31, 2026
docs: scrub internal/private-project references from published docs
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
1 participant
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.
Removes references that leaked unpublished sibling projects, local filesystem paths, and agent-process artifacts into the public tree — while preserving the (public) technical substance and all legitimate license attribution.
Removed
~/oss/*,/home/gburd/ws/*,/Users/gregburd/*, a/nix/storeTCL path, a build-worktree path.agent/test-triageworktree note and every reference to gitignored.agents/*.mdworking notes (→ "the test-suite maturity plan" / inline).Kept deliberately (not leaks)
src/os/os_aio_*.c— proper provenance ("adapted … with the author's permission").hegel-cdependency the PBT tests clone.Comment-only edits to
sim_scenario.h/test_sim_crash_recover.c/adaptive.h(no code change); scripts +rank_coverage.pyre-verified to parse.Note: does not touch the OCR (AI-review) system or rewrite history — those are pending separate decisions.