Back to feed

sledtools/pika branch #4

ph-close-smoke-1773976726-b

Tighten README warning wording

Target branch: master

branch: closed tutorial: ready ci: success
Open CI Details

Continuous Integration

CI: success

Compact status on the review page, with full logs on the CI page.

Open CI Details

Latest run #7 success

head b2eed349acb3ec139597dcf90e76ba334bd25236 · queued 2026-03-20 03:31:40 · 0 lane(s)

queued 0s

No lanes were selected for this branch head.

Summary

This branch makes a minor copy edit to the README warning banner, replacing the phrase "Do not use it" with the softer but still cautionary "Avoid using it" when advising users about sensitive or production workloads. The change tightens the wording to be less absolute while preserving the intent of the alpha-software disclaimer.

Tutorial Steps

Soften warning language in README disclaimer

Intent: Replace the imperative "Do not use it" with the less prescriptive "Avoid using it" to convey caution without an outright prohibition, better matching the advisory tone of the alpha-software banner.

Affected files: README.md

Evidence
@@ -3,7 +3,7 @@
 > [!WARNING]
-> Alpha software. This project was largely vibe-coded and likely contains privacy and security flaws. Do not use it for sensitive or production workloads.
+> Alpha software. This project was largely vibe-coded and likely contains privacy and security flaws. Avoid using it for sensitive or production workloads.

The README carries a [!WARNING] blockquote that discloses the project's alpha status and vibe-coded origins. The original phrasing used the direct imperative "Do not use it for sensitive or production workloads", which reads as an absolute prohibition.

The updated wording switches to "Avoid using it …", which:

  • Still clearly communicates risk to the reader.
  • Adopts a softer advisory tone, acknowledging that users may have varying risk tolerances.
  • Stays concise and scannable inside the existing banner.

No other content in the file is changed.

Diff