Skip to content

docs: fix rendering and index inconsistencies (escaped backticks, backslash escapes, module lists, Bash floor) #556

Closed

Description

@codeforester

Goal

Fix small documentation defects that render incorrectly or contradict neighbouring pages.

Background

  • docs/support-matrix.md contains backslash-escaped backticks on 14 lines (for example \tests/compatibility-matrix.sh``). Inside GitHub-rendered Markdown these show literal backslashes and break the code formatting throughout the table and later sections.
  • lib/bash/str/README.md:37 and lib/bash/app/README.md:38 write the escape sequences as \\t, \\n, \\r inside code spans, which renders two backslashes. lib/bash/git/README.md:23 shows the correct form (\\, \t, \n).
  • STANDARDS.md ("Shell Library Shape") lists std, file, git, gh, str, arg, list but omits process, cli, and app, which lib/bash/README.md and base_api_manifest.yaml list as modules.
  • docs/README.md ("Start here") omits the pinned-consumption, vendor-workflow, single-file-distribution, versioning-policy, release-process, integrations, and community pages that the root README's documentation map includes.
  • The README badge/text (README.md:5,22) say "Bash 4.2+" while the support matrix and policy say the minimum is Bash 4.2.53.

Scope

Fix each item above; keep the documentation-contract tests green.

Acceptance Criteria

  • No stray backslash-escaped backticks remain in any *.md file.
  • Escape sequences in code spans render as the actual sequences.
  • STANDARDS.md and docs/README.md list the same modules/pages as the manifest and root README map (or say why not).
  • The minimum Bash version is stated consistently as 4.2.53 (or "4.2+" is qualified).
  • ./tests/validate.sh passes.

Validation

grep -rn '\\' --include='*.md' .` returns nothing relevant; view the rendered pages on GitHub.

Project Fields

  • Status: Backlog
  • Priority: P3
  • Area: Docs
  • Size: S
  • Issue type: Task
  • Assignee: codeforester
  • Milestone: v2.2.0

Agent Assignment

Assignee: @codeforester. Found during the pre-release documentation walkthrough of 2026-10-07 at the origin/main heads of base-bash-libs (454aabc) and base-bash-libs-demo (5e598be). No repository content was changed by the review.

Activity

  1. added this to the v2.2.0 milestone on Oct 6, 2026
  2. self-assigned this
    on Oct 6, 2026
  3. added theissue type on Oct 6, 2026
  4. linked a pull request that will close this issuedocs: fix rendering and support indexes #561on Oct 7, 2026
  5. added a commit that references this issue on Oct 7, 2026
    71a32e0
  6. moved this from In Progress to Done in base-bash-libson Oct 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationDocumentation improvements

Type

Projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions