Skip to content

docs: fully rewrite docs#202

Merged
PsiACE merged 7 commits into
mainfrom
bub-docs
May 9, 2026
Merged

docs: fully rewrite docs#202
PsiACE merged 7 commits into
mainfrom
bub-docs

Conversation

@PsiACE
Copy link
Copy Markdown
Collaborator

@PsiACE PsiACE commented May 6, 2026

This pull request introduces significant improvements to the Bub documentation site, focusing on the developer experience for building with Bub as a framework. The changes reorganize and expand the "Build" section, add new comprehensive guides and recipes, and clarify the documentation structure to better support plugin, distribution, and embedding scenarios. Additionally, the navigation and sidebar structure are updated to reflect these new themes.

Key documentation and structural updates:

Documentation Expansion and Improvements:

  • Added a new "Build with Bub" landing page that explains the three main ways to extend or embed Bub: writing plugins, embedding the framework programmatically, or wrapping Bub as a product distribution. This page also introduces the stability promise and points to the plugin ecosystem. (website/src/content/docs/docs/build/index.mdx)
  • Added a comprehensive "Plugins" guide covering package layout, entry points, plugin shapes (module, instance, callable), editable installs, and diagnostics, with real-world examples. (website/src/content/docs/docs/build/plugins.mdx)
  • Added a "Hook recipes" cookbook with practical examples for common hook patterns, such as overriding prompts, replacing models, wrapping streams, persisting state, providing tape stores, adding channels, registering CLI commands, and onboarding config. (website/src/content/docs/docs/build/hooks.mdx)
  • Added a "Distribution" guide demonstrating how to package Bub as a product, including pinning the kernel, shipping a custom CLI, bundling plugins and skills, and embedding Bub programmatically, using visual-base as a case study. (website/src/content/docs/docs/build/distribution.mdx)

Navigation and Sidebar Structure:

  • Updated the documentation sidebar to introduce new top-level sections: "Operate", "Build", and "Reference", replacing the previous "Guides" and "Extending" sections. The new structure better aligns with the expanded developer documentation and provides clearer navigation for different user goals. (website/astro.config.mjs)

Tooling:

  • Updated the Node.js version in .node-version to 22.12.0 to ensure compatibility with the latest tooling. (.node-version)

Signed-off-by: Chojan Shang <psiace@apache.org>
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 6, 2026

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
bub 50e94bf Commit Preview URL

Branch Preview URL
May 09 2026, 06:50 AM

@PsiACE
Copy link
Copy Markdown
Collaborator Author

PsiACE commented May 6, 2026

It's almost done; just need some time to refine it

PsiACE added 6 commits May 8, 2026 02:32
Signed-off-by: Chojan Shang <psiace@apache.org>
Signed-off-by: Chojan Shang <psiace@apache.org>
Signed-off-by: Chojan Shang <psiace@apache.org>
Signed-off-by: Chojan Shang <psiace@apache.org>
Signed-off-by: Chojan Shang <psiace@apache.org>
@PsiACE PsiACE merged commit 16a9d89 into main May 9, 2026
6 checks passed
@PsiACE PsiACE deleted the bub-docs branch May 9, 2026 06:54
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.

1 participant