docs(developers): fill the five developer pages (Cycle 17)#20
Merged
Conversation
…t, API, providers, bundles (Cycle 17)
Replace the developers/* stubs with real, verified content for a competent
developer: the monorepo at a glance + data flow, the framework-agnostic
"runs anywhere" pitch with the real public API, get-running-fast commands,
how to extend (custom TtsProvider, bundles, frameworks), and the project
conventions. Every signature is copied from packages/{core,types,voice-truvoice}
source; every command exists in package.json.
Packages are still private/unpublished, so quickstart frames `npm i` as
"once published" and leads with the working clone + pnpm path (ADR-0025:
ship only what's real, signpost the rest). Screenshots/GIFs are signposted
for the next cycle, not faked. Docs only; no code; CI green.
Co-Authored-By: Claude Opus 4.8 (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.
Cycle 17 — developer documentation pages
Fills the five
docs/developers/*stubs (which the README and docs landing already link to) with accurate, verified content. The audience flips here: these target a competent developer who wants to embed vivify or contribute, not the zero-assumptions nostalgia visitor. Voice per the parkedvision-and-docs-spec.md. Docs only — no code; CI green.Cycle spec:
docs/cycles/cycle-17-developer-page.md.Pages
architecture.md), the framework-agnostic "runs anywhere" pitch with the real public API, get-running-fast from source, how to extend, project conventions.WebSpeechProvider(zero-backend audible voice).stopCurrentvsstop).TtsProviderseam, the three shipped providers, writing your own.acs2bundle, raw-.acs-vs-bundle, hosting viaCharacterBundleRef.Honesty call
All
@vivify/*packages areprivate/0.0.0(unpublished). The quickstart framesnpm ias "once published" and leads with the working clone +pnpmpath, per ADR-0025 (ship only what's real, signpost the rest). Nonpm iline is presented as working today.Verification
pnpm -r typecheck && pnpm -r test && pnpm lint && pnpm format— all green (docs-only; Markdown is prettier-ignored).packages/{core,types,voice-truvoice}/src; every command checked againstpackage.json.code-reviewerverified signatures/commands/links/ADR citations independently — no blockers.Out of scope
Screenshots / GIFs (next cycle — signposted, not faked). No code, no package publishing, no merge.
🤖 Generated with Claude Code