Skip to content

Docs: cut repeated claims from the README and the security overview - #5

Merged
SandObserver merged 1 commit into
mainfrom
docs/tighten-repeated-passages
Aug 9, 2026
Merged

SandObserver merged 1 commit into
mainfrom
docs/tighten-repeated-passages

Conversation

@SandObserver

Copy link
Copy Markdown
Owner

Summary

  • README.md: drop the second description of the launcher grid under "Why Stackyard", keeping the mobile-layout and language facts it also carried.
  • README.md: remove "with no external services or dependencies" from the intro, which the "No dependencies" bullet states with its rationale 20 lines later.
  • docs/security.md: merge the two opening paragraphs of "Network exposure" into one. Every claim is kept (no TLS, rate-limited logins, authentication is not an internet boundary, trusted network or reverse proxy); only the repeated "do not expose it" instruction goes.
  • docs/security.md: repair the SBOM sentence, which was left broken mid-clause, and split the scan and the SBOM into separate paragraphs.

Testing
All green, including the 11 tests in api/test/security-doc.test.js that pin the security document's checkable claims by value. No new tests: no technical claim changed.

Checklist

  • Stays within the project constraints: one container, no runtime dependencies, no build step (see CONTRIBUTING.md).
  • Tests added or updated for new logic, and the full suite, lint, and typechecks pass.
  • Docs updated if behavior or configuration changed.
  • CHANGELOG.md updated under Unreleased if the change is user-visible.

The README described the launcher grid twice, in the intro and again under Why
Stackyard, and stated the no-dependency claim in both places; the second copy of
each said less than the first. The security overview opened with two paragraphs
that both told the reader not to expose Stackyard to the internet.

Also repairs a sentence in the release-verification section that was left broken
mid-clause, and separates the scan from the SBOM.
@SandObserver SandObserver added the documentation Improvements or additions to documentation label Aug 9, 2026
@SandObserver
SandObserver merged commit f4e9f91 into main Aug 9, 2026
3 checks passed
@SandObserver
SandObserver deleted the docs/tighten-repeated-passages branch August 9, 2026 20:07
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