Docs: update Files section to list all CLI tools#510
Open
casks-mutters wants to merge 1 commit intomainfrom
Open
Docs: update Files section to list all CLI tools#510casks-mutters wants to merge 1 commit intomainfrom
casks-mutters wants to merge 1 commit intomainfrom
Conversation
## Summary The README's `## Files` section currently lists only: - `app.py` - `README.md` However, the repository now also includes several additional CLI helpers: - `batch_slot_diff.py` - `slot_diff_attest.py` - `slot_layout_probe.py` - `slot_change_stream.py` - `slot_change_finder.py` This mismatch may confuse users browsing the repo or trying to discover available tools. ## Changes - Update the `## Files` section in `README.md` to include all of the main Python entrypoints and a one-line explanation for each: - `app.py` – single-slot, two-block commitment checker (core tool). - `batch_slot_diff.py` – batch CSV processor for many slots/blocks. - `slot_diff_attest.py` – signed JSON attestation generator. - `slot_layout_probe.py` – scan ranges of slots and emit CSV/commitments. - `slot_change_stream.py` – live monitor for slot changes over new blocks. - `slot_change_finder.py` – helper to search for the first block where a slot value changed (if applicable). - Keep `README.md` itself listed as the documentation file. ## Rationale - Keeps documentation in sync with the actual repository contents. - Makes the additional tools discoverable for users who only read the README. - Helps people quickly pick the right script for their use case (single slot vs batch vs streaming vs layout probing). ## Notes This is a docs-only change; no code behavior is modified.
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
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
The README's
## Filessection currently lists only:app.pyREADME.mdHowever, the repository now also includes several additional CLI helpers:
batch_slot_diff.pyslot_diff_attest.pyslot_layout_probe.pyslot_change_stream.pyslot_change_finder.pyThis mismatch may confuse users browsing the repo or trying to discover available tools.
Changes
## Filessection inREADME.mdto include all of the main Python entrypoints and a one-line explanation for each:app.py– single-slot, two-block commitment checker (core tool).batch_slot_diff.py– batch CSV processor for many slots/blocks.slot_diff_attest.py– signed JSON attestation generator.slot_layout_probe.py– scan ranges of slots and emit CSV/commitments.slot_change_stream.py– live monitor for slot changes over new blocks.slot_change_finder.py– helper to search for the first block where a slot value changed (if applicable).README.mditself listed as the documentation file.Rationale
Notes
This is a docs-only change; no code behavior is modified.