docs: align rustdoc with README, add doc review to maintenance#500
Merged
docs: align rustdoc with README, add doc review to maintenance#500
Conversation
…nance checklist - Update lib.rs command table from 68+ to 100+ with all categories matching README (byte tools, disk, pipeline categories; added pushd/popd/dirs, declare/typeset/let, trap/caller/getopts/shopt, paste/column/diff/comm/strings/tac/rev/seq/expr, mktemp/chown/ln/realpath, od/xxd/hexdump, df/du, watch/yes/kill) - Add logging_guide to Guides section, consolidate threat_model into Guides - Fix Python README command count from 68+ to 100+ - Add dedicated Rust docs and Python docs review sections to 012-maintenance.md checklist covering lib.rs alignment, doc module completeness, and Python binding docs accuracy https://claude.ai/code/session_01TY6qrBf9zut918FWh7QhjB
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
lib.rscrate-level docs command table from 68+ to 100+, matching all categories and entries inREADME.md(byte tools, disk, pipeline categories; dozens of missing commands added)logging_guideto Guides section, consolidatethreat_modelinto GuidesREADME.mdcommand count from 68+ to 100+specs/012-maintenance.md) Section 4 with dedicated sub-sections for Rust docs review and Python docs reviewTest plan
cargo doc --all-featuresbuilds clean (no warnings)cargo test --doc --all-features— 73 passed, 0 failedcargo doc --opento confirm command table renders correctly