docs: rewrite platform docs as the shipped-venue source of truth#474
Open
mfw78 wants to merge 1 commit into
Open
docs: rewrite platform docs as the shipped-venue source of truth#474mfw78 wants to merge 1 commit into
mfw78 wants to merge 1 commit into
Conversation
Doc 05 documents both personas as shipped: the videre-sdk surface, the venue and keeper macros, the typed client, and an author-a-venue walkthrough on the echo pair, with the CoW crates as the production instance. Doc 08 names venue adapters as the domain-extension mechanism, replaces the Layer-3 world-include pattern with the videre:venue contract and the registry route, marks shepherd:cow as the retired legacy read path (cow-events stays as the event-ABI package of record), and squares the WIT layout, server table, and SDK layering with the tree. One inbound sdk.md anchor follows the doc 05 heading.
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.
What
Rewrites docs/05-sdk-design.md and docs/08-platform-generalisation.md (plus one link fix in docs/sdk.md) to match the shipped M1-M3 architecture: the venue persona (
videre-sdk,#[videre_sdk::venue]/#[videre_sdk::keeper]) is documented as shipped, venue adapter components are named as the sole domain-extension mechanism, andshepherd:cow/cow-apiis reframed as the retired legacy read path (cow-eventsABI package of record only).Why
The prior docs were actively misleading post-M1-M3: doc 05 described the venue persona as unshipped design intent when it ships, and doc 08 still documented the deprecated Layer-3 host-extension model as the live mechanism. Closes #401.
Testing
Docs-only change; no code touched. Prose reviewed against the M3 tip crate layout (nexum-sdk, videre-sdk, videre-macros, videre-test, cow-venue, composable-cow).
AI Assistance
Drafted with AI assistance under human review.
Closes #401