docs: soften fork framing, add logo, fix upstream author (#17)#29
Merged
docs: soften fork framing, add logo, fix upstream author (#17)#29
Conversation
Three related doc corrections after Phase 5 landed:
* README framing: rewritten "About this fork" section at top of
the README. Explicit that this is a FORK, not a rewrite; that
the upstream at rgooding/go-syncmap is fully usable and
recommended for anyone who doesn't need AxonOps packaging; and
that the fork exists only for the release/CI/security
discipline needed to consume it inside AxonOps. Removed the
aggressive "Why syncmap?" marketing section; the respectful
framing is the whole pitch now.
* CHANGELOG v1.0.0 entry retuned to match — replaces "rebuilt to
AxonOps library standards" with "consumed under AxonOps
engineering controls", names the fork as packaging-only, and
states that library behaviour is unchanged from upstream apart
from the small API additions already enumerated in the entry.
* Upstream author: Robert Gooding → Richard Gooding across
NOTICE, CHANGELOG, README, and the governance test assertion.
Earlier attribution to Robert was an incorrect guess.
* Assets: logo-readme.png (1024x1024 gopher from gopher.png in
the repo root) placed at .github/images/logo-readme.png per
mask's convention and referenced from the README hero. A
1280x640 social preview with the gopher centred on white is
at .github/images/social-preview-1280x640.png for the repo
Settings -> Social preview upload.
* llms-full.txt regenerated.
Documentation only; no code change. Coverage remains 100%.
|
Thank you for your contribution! Before we can merge this PR, you need to sign our Contributor License Agreement. To sign, post a comment on this PR containing exactly:
The CLA is a one-time agreement that covers every future contribution you make to any AxonOps open-source project. If you have questions before signing, please open a discussion or email I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
Summary
Three follow-ups to the #17 docs landing:
rgooding/go-syncmap. New "About this fork" section at the top of the README explicitly tells users that the upstream is fully usable and recommended, and that this fork exists only so AxonOps can consume the library under our release/CI/security discipline. The previous "Why syncmap?" marketing section is gone.Robert Gooding→Richard Goodingacross NOTICE, CHANGELOG, README, and the governance test assertion.llms-full.txtregenerated.Local validation
Post-merge
Upload `.github/images/social-preview-1280x640.png` via Settings → Social preview. GitHub doesn't pick up repo-tracked images automatically — it requires the manual upload.
Agent gates
Test plan