Document community characters + recaps - #14
Merged
Conversation
Closes the docs DoD lag from server #38 / frontend #58, which shipped the characters + 'story so far' recap layer through the /meta seam without the docs catch-up: - server/api/reference.md: work.characters / work.recaps on the /meta envelope (position model, character/recap fields, role enum, the xref the server drops). - frontend/state-and-data.md: the Characters + Story so far render in BookMetaSection (closed-by-default accordions, tested label helpers). - listening/browsing.md: the user-facing Characters + Story so far sections under 'About this book', framed spoiler-safe.
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.
Closes the docs DoD lag from audiosilo-server #38 / audiosilo-frontend #58, which shipped the community characters + story so far recap layer end-to-end (the
/metaseam) without the docs catch-up.Changes
work.characters/work.recapsadded to theGET /libraries/{id}/metaexample and documented: the edition-independent position model ({chapter}), the character fields (id/name/aliases/role enum/reveal/description), the recap fields (through/scope/text), and the note that the server passes these straight through from upstreamGET /works/{id}but drops the characterxref.BookMetaSection(closed-by-default accordions, no blur; the unit-tested label helpers).Verification
npm run buildgreen (throws on broken links/anchors/images).roleenum, and the droppedxrefverified against the serverinternal/metastructs, the frontendtypes.ts+book-meta.tsxhelpers, and the audiosilo-meta schema.xref.