docs: correct stale toolchain version and unwrap prose - #66
Merged
Conversation
CONTRIBUTING listed bashunit 0.17.0 in the toolchain table; the repo has been on 0.45.0 since #64, so anyone matching that table locally would install a version whose doubles API the suite no longer targets. The landing page advertised concurrency as BASHDEP_JOBS only, predating the --jobs=N flag added in #64. Prose across README and docs/ is no longer hard-wrapped at 80 columns. .editorconfig sets max_line_length for **.sh (120) and never for **.md, so long lines lint clean and reworded sentences stop reflowing whole paragraphs in diffs. Code blocks, tables and lists are untouched.
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.
🔗 Ticket
🤔 Background
Two real defects surfaced while auditing the docs after #64:
CONTRIBUTING.mdstill pinned bashunit0.17.0in the toolchain table. The repo moved to0.45.0in chore(deps): update bashunit to 0.45.0, pin CI actions, add --jobs #64, so a contributor matching that table would install a version whose doubles API the suite no longer targets — exactly the failure chore(deps): update bashunit to 0.45.0, pin CI actions, add --jobs #64 was about.BASHDEP_JOBSonly, predating the--jobs=Nflag.Separately, all prose was hard-wrapped at 80 columns, which makes documentation diffs noisy: rewording one sentence reflows the entire paragraph.
💡 Goal
Make the docs accurate against the current code, and stop hard-wrapping markdown prose.
🔖 Changes
CONTRIBUTING.md: bashunit0.17.0→0.45.0in the toolchain table.site/index.html: the feature list, the feature card, and the pipeline diagram now name--jobs=NalongsideBASHDEP_JOBS. Diagram column alignment preserved.README.md,docs/api.md,docs/behavior.md,docs/README.md,docs/releasing.md,.github/CONTRIBUTING.md.The unwrap was scripted with code fences, tables, blockquotes, headings, indented blocks and list-item boundaries all protected, then diff-reviewed. Only prose lines were joined — no wording changed, nothing reordered, no content removed.
🖼️ Screenshots
BEFORE
AFTER
✅ Verification
make checkclean: 252 tests, ShellCheck, editorconfig.editorconfigsetsmax_line_lengthfor**.sh(120) only, never for**.md, so the long lines lint clean