docs(runtime): move narrative comments into crate docs, trim inline chatter - #1900
Draft
ohdearquant wants to merge 1 commit into
Draft
docs(runtime): move narrative comments into crate docs, trim inline chatter#1900ohdearquant wants to merge 1 commit into
ohdearquant wants to merge 1 commit into
Conversation
…hatter Extract design narratives from operations.rs and secret_gate.rs into crates/khive-runtime/docs/ (new operations.md; extended api/secret_gate.md) and trim inline comments to constraint one-liners: -467 comment lines in code, +222 lines of structured crate docs. Comment and doc lines only; no executable code, signatures, or test logic changed. cargo fmt --check and cargo doc -D warnings both pass.
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.
First pass of a comment-to-docs alignment series. Extracts design narratives from
khive-runtime's two comment-densest files into structured crate docs and trims the inline comments to constraint one-liners.crates/khive-runtime/docs/operations.md(new): module-split rationale, fault-injection static-state design, and concurrency/correctness notes foratomic_hard_delete_with_edge_purge,merge_traversal_paths_by_root, andupdate_edge_symmetric_dml.crates/khive-runtime/docs/api/secret_gate.md(extended): bridge-fragment reconstruction rationale and the full per-token detection sequence forcheck_entropy_heuristic.secret_gate.rs: 1368 → 1129 comment lines.operations.rs: 2040 → 1924 (partial pass; a follow-up will cover the remainder).cargo fmt -p khive-runtime --checkandRUSTDOCFLAGS="-D warnings" cargo doc -p khive-runtime --no-depsboth pass.