Skip to content

docs: correct stale toolchain version and unwrap prose - #66

Merged
Chemaclass merged 1 commit into
mainfrom
docs/optimize-docs
Aug 9, 2026
Merged

docs: correct stale toolchain version and unwrap prose#66
Chemaclass merged 1 commit into
mainfrom
docs/optimize-docs

Conversation

@Chemaclass

Copy link
Copy Markdown
Owner

🔗 Ticket

🤔 Background

Two real defects surfaced while auditing the docs after #64:

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: bashunit 0.17.00.45.0 in the toolchain table.
  • site/index.html: the feature list, the feature card, and the pipeline diagram now name --jobs=N alongside BASHDEP_JOBS. Diagram column alignment preserved.
  • Unwrapped prose in 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

- `bashdep::clean` returns the number of orphans it could not remove
  (capped at 255), reporting each failed removal to stderr; `0` when all
  orphans were removed.

AFTER

- `bashdep::clean` returns the number of orphans it could not remove (capped at 255), reporting each failed removal to stderr; `0` when all orphans were removed.

✅ Verification

  • make check clean: 252 tests, ShellCheck, editorconfig
  • .editorconfig sets max_line_length for **.sh (120) only, never for **.md, so the long lines lint clean
  • Tables, code blocks and multi-line bullets spot-checked in every touched file

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.
@Chemaclass Chemaclass added the documentation Improvements or additions to documentation label Aug 9, 2026
@Chemaclass Chemaclass self-assigned this Aug 9, 2026
@Chemaclass
Chemaclass merged commit 8f12208 into main Aug 9, 2026
4 checks passed
@Chemaclass
Chemaclass deleted the docs/optimize-docs branch August 9, 2026 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant