docs: frame-inventory pages + package badges (0.3.0 follow-up) - #7
Merged
Conversation
…ames The feature commit added the authoring guides but left the site's *inventory* pages describing the closed pre-0.3 wire: concepts, protocol overview, identity and persistence all enumerated PERSISTENT_FRAME_TYPES without the open rich message entry, the event-mapping tables had no `$mekik:"message"` row (nor mount/choose/message in the helper table), and the conformance fixture table was missing `rich-message`. A reader landing on any of them would have concluded the frame list was closed. Also drops the "five helpers" claim in the helpers page, which the same commit had already made false. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The README's only badge was CI, so a reader had no way to see — or click through to — what's actually published. Four badges, one per package a consumer installs directly: @mekik/core and @mekik/ws on npm, Mekik.Core and Mekik.AspNetCore on NuGet. Each renders the live version, so they double as the answer to "what's the current release?". @mekik/langchain and @mekik/redis are left out deliberately: they're optional integrations, listed in the layout section, and six badges would bury the CI one. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
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.
Two docs fixes that belong to the 0.3.0 release. The first was written before the merge but lost by it —
gh pr mergeon #6 merged the branch at its previous head, so commit6264bc8never landed. Cherry-picked here unchanged.1. Carry the new frame family into the pages that list frames
#6 added the authoring guides but left the site's inventory pages describing the closed pre-0.3 wire:
concepts.mdandprotocol/overview.mdprintedPERSISTENT_FRAME_TYPESwith no mention of the open rich-message entryprotocol/identity.mdandpersistence.mdenumerated the persistent frames the watermark and transcript cover — without rich messages, which are persistentprotocol/event-mapping.mdhad no$mekik:"message"row, and its helper table was missingmount/choose/messageparity/conformance.mdwas missing therich-messagegolden fixtureA reader landing on any of those would have concluded the frame list was closed. Also drops the "five helpers" claim in the helpers page, which #6 had already made false.
2. Package badges in the README
The README's only badge was CI, so nothing linked to what's actually published. Four badges —
@mekik/core,@mekik/ws(npm),Mekik.Core,Mekik.AspNetCore(NuGet) — each rendering the live version, so they double as the answer to "what's the current release?".@mekik/langchainand@mekik/redisare left out on purpose: optional integrations, already in the layout section, and six badges would bury the CI one.Verification
Docusaurus build clean (broken internal links fail that build). Docs-only — no source, no version, no wire change.
🤖 Generated with Claude Code