Skip to content

Add Seed Bible extension API reference documentation - #148

Open
KallynGowdy wants to merge 1 commit into
mainfrom
claude/awesome-hypatia-ud5cza
Open

KallynGowdy wants to merge 1 commit into
mainfrom
claude/awesome-hypatia-ud5cza

Conversation

@KallynGowdy

Copy link
Copy Markdown
Collaborator

Summary

This PR adds comprehensive API reference documentation for the Seed Bible extension development platform. The reference is automatically generated from the seed-bible npm 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 the seed-bible package's type declarations. The script:

    • Processes three entry points: seed-bible/extensions, seed-bible/extensions/testing, and seed-bible/components
    • Generates organized reference pages with a sidebar structure
    • Handles unexported types used by exports but not directly importable
    • Outputs a sidebar.json file for VuePress integration
  • Documentation landing page (docs/seed-bible/README.md): Introduces the Seed Bible extension platform with:

    • Quick start instructions
    • Links to external developer guides
    • Overview of the three main packages developers import from
    • Guide to reading the API reference
  • VuePress configuration updates (docs/.vuepress/config.ts):

    • Added Seed Bible navbar link (English-only, consistent across all languages)
    • Integrated generated sidebar into the site structure
    • Added seedBibleReferenceSidebar() function to load the generated sidebar.json
    • Added tsx to Shiki syntax highlighting languages
  • Build process integration (docs/package.json):

    • Added generate:seed-bible-reference script
    • Updated dev and build scripts to generate reference before building
    • Added dependencies: seed-bible, typedoc, typedoc-plugin-markdown, typedoc-plugin-missing-exports, preact, and @preact/signals
  • Translation handling (tools/translate-docs.ts): Excluded seed-bible/ directory from translation since the API reference is English-only and auto-generated

  • Git configuration (docs/.gitignore): Added seed-bible/reference/ to ignore generated files

  • Navigation labels (docs/.vuepress/labels.json): Added "Seed Bible" label for navbar

Notable Implementation Details

  • The generator creates a custom ReferenceRouter class that strips the seed-bible/ prefix from module names, so pages land at reference/extensions/ rather than reference/seed-bible/extensions/
  • TypeDoc's internalModule is set to "Unexported types" to document types that are used but not exported, with explanatory text added to that page
  • The sidebar structure maps TypeDoc's navigation tree to VuePress sidebar items with proper link resolution
  • Generated reference pages are excluded from version control but included in builds via the automated generation step

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
@github-actions

Copy link
Copy Markdown

This branch was successfully deployed

1 active deployment
docs-preview — 48352c4b Deployed Nov 18, 2026 by KallynGowdy via Deploy preview #39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants