Skip to content

docs: improve README front door - #1956

Merged
codeforester merged 1 commit into
mainfrom
documentation/1942-20260816-docs-readme-front-door-buries-quickstart-lacks-a-toc-oversel
Aug 16, 2026
Merged

docs: improve README front door#1956
codeforester merged 1 commit into
mainfrom
documentation/1942-20260816-docs-readme-front-door-buries-quickstart-lacks-a-toc-oversel

Conversation

@codeforester

Copy link
Copy Markdown
Collaborator

Summary

  • Put a runnable source-checkout quickstart immediately after the product pitch.
  • Define “local operating contract” in plain language and add a contents map near the top.
  • Replace the overstated “90-Second Proof” label with a trust-conscious proof description.
  • Mark the detailed product-layer command section as a skippable deep reference with focused-doc links.

Validation

  • git diff --check
  • /Users/rameshhp/.base.d/base/.venv/bin/python -m pytest tests/test_bootstrap_docs.py tests/test_contract_hardening.py -q — 17 passed

Fixes #1942

@codeforester
codeforester marked this pull request as ready for review August 16, 2026 06:03
@codeforester
codeforester requested a review from a team as a code owner August 16, 2026 06:03
@codeforester
codeforester merged commit b43f22e into main Aug 16, 2026
28 checks passed
@codeforester
codeforester deleted the documentation/1942-20260816-docs-readme-front-door-buries-quickstart-lacks-a-toc-oversel branch August 16, 2026 06:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: README front door buries quickstart, lacks a TOC, oversells the '90-Second Proof'

1 participant