docs: rewrite the README status notice and fix the opifex URL casing - #4
Merged
Merged
Conversation
Staged as patches/DiffBio/2026-08-18-002-readme-launch-readiness in avitai-portfolio. Applied against 1ea84a3.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs: launch-readiness pass on the DiffBio README
What
Two changes, both required by
decisions/0006-public-launch-plan.mdbefore launch:This file carried 3 em-dashes.
Why the banner changes
Every one of the six launch repos carried a banner that told visitors not to engage. The APIs
genuinely are unstable, so deleting the warning was considered and rejected: it is the one change
here that could actually cost credibility rather than stars. Instead the same information is
stated with an invitation attached, which is the higher-converting frame for a pre-1.0 project and
is also simply more accurate about what we want.
Nothing about maturity is softened. Pre-1.0 status, pinning advice, and the not-for-production
warning all remain.
Repo-specific notes
github.com/avitai/Opifex(capital O) to the canonical lowercaseopifex.Verification
python3 scripts/check_published_prose.pypasses on this file: zero em-dashes, zero en-dashes,zero banned verbs, middle dots within limit. The replacements were spot-checked by hand rather
than trusted to the transform: every site was a bullet-label separator where a regular hyphen
reads naturally.