Repository navigation
Add Seed Bible extension API reference documentation - #148
Open
KallynGowdy wants to merge 1 commit into
Open
KallynGowdy wants to merge 1 commit into
KallynGowdy wants to merge 1 commit into
Conversation
The docs site now has a Seed Bible section (navbar: "Seed Bible") with an API reference for third-party extension developers. It covers the three entry points a sandboxed extension imports: seed-bible/extensions, seed-bible/extensions/testing and seed-bible/components. Every class, interface, type, function and component gets its own page, types link to each other, and the sidebar lists each package's members by kind. The pages are generated by TypeDoc (with typedoc-plugin-markdown) from the type declarations of the seed-bible npm package that docs/package.json pins, so they match what developers install. `pnpm dev` and `pnpm build` regenerate them; they are git ignored. Types the packages use without exporting are listed on an "Unexported types" page per package so no link dead-ends. The section is English only, so translate-docs skips it and every language's navbar links to the English pages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019LsURzJUPiQG5pGJ5B9mac
Docs previewDeployed 48352c4 to Cloudflare Workers. |
This branch was successfully deployed
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.
Summary
This PR adds comprehensive API reference documentation for the Seed Bible extension development platform. The reference is automatically generated from the
seed-biblenpm package's type declarations, ensuring it always matches what developers install.Key Changes
New generator script (
.vuepress/seed-bible/generate-reference.mjs): Uses TypeDoc and typedoc-plugin-markdown to generate markdown documentation from theseed-biblepackage's type declarations. The script:seed-bible/extensions,seed-bible/extensions/testing, andseed-bible/componentssidebar.jsonfile for VuePress integrationDocumentation landing page (
docs/seed-bible/README.md): Introduces the Seed Bible extension platform with:VuePress configuration updates (
docs/.vuepress/config.ts):seedBibleReferenceSidebar()function to load the generatedsidebar.jsontsxto Shiki syntax highlighting languagesBuild process integration (
docs/package.json):generate:seed-bible-referencescriptdevandbuildscripts to generate reference before buildingseed-bible,typedoc,typedoc-plugin-markdown,typedoc-plugin-missing-exports,preact, and@preact/signalsTranslation handling (
tools/translate-docs.ts): Excludedseed-bible/directory from translation since the API reference is English-only and auto-generatedGit configuration (
docs/.gitignore): Addedseed-bible/reference/to ignore generated filesNavigation labels (
docs/.vuepress/labels.json): Added "Seed Bible" label for navbarNotable Implementation Details
ReferenceRouterclass that strips theseed-bible/prefix from module names, so pages land atreference/extensions/rather thanreference/seed-bible/extensions/internalModuleis set to "Unexported types" to document types that are used but not exported, with explanatory text added to that page