Build With Funnable

Welcome to the Funnable developer docs. Everything under /docs ships with the repo so you can browse offline, and CI can fail early if documentation generation breaks.

What lives here?

• /docs/getting-started – this page, which walks through local setup and navigation.
• /docs/@fun-sdk/core – autogenerated API reference sourced from the TypeScript docblocks inside sdk/core.

Generating the docs locally

pnpm docs:generate

Running the command above will scan the SDK sources, refresh the MDX files under docs/sdk-core, and unblock the Next.js docs routes. pnpm build already runs this script for you, so CI will always have the latest reference.

Navigating the reference

• Use the sidebar to jump between SDK symbols such as Funnable, FunnableChat, and the UI helpers.
• Follow the breadcrumbs in each page to return to the full index quickly.
• Because each doc entry is rendered directly from MDX, you can safely open pull requests that tweak text, add examples, or introduce new sections.

Happy building! If you spot gaps, open an issue or drop feedback in #devrel.