Skip to content

Docs: consolidate dual introductions, restructure setup page#348

Merged
cameronapak merged 5 commits intomainfrom
intro-docs-updates
Feb 7, 2026
Merged

Docs: consolidate dual introductions, restructure setup page#348
cameronapak merged 5 commits intomainfrom
intro-docs-updates

Conversation

@cameronapak
Copy link
Collaborator

@cameronapak cameronapak commented Feb 7, 2026

Summary

  • Eliminated confusing dual "Introduction" pagesstart.mdx and usage/introduction.mdx both served as introductions with overlapping content (modes, setup). Readers saw two "Introduction" entries in the sidebar under different sections.
  • Renamed usage/introduction.mdxusage/setup.mdx ("Setup & Modes") and rewrote it as a how-to guide with decision guidance instead of a dense reference doc
  • Tightened start.mdx — sharper one-liner, concise feature list, better quickstart→modes flow, motivation card
  • Updated all internal links across admin.mdx, config.mdx, database.mdx, cli.mdx, and meta.json

start.mdx changes

  • New one-liner: "bknd is a lightweight batteries-included backend that embeds into your frontend app"
  • Quickstart walkthrough now bridges naturally into modes: "What you just experienced is UI-only mode"
  • StackBlitz promoted to its own section
  • Added motivation card link
  • Tightened copy throughout (removed filler, fixed "REST API's" → "REST APIs")

setup.mdx (new, replaces usage/introduction.mdx)

  • Opens with "Choose your mode" decision guide instead of abstract createApp code
  • Plain-language guidance: "UI-only is best for prototyping, Code-only for teams/CI, Hybrid for both"
  • One minimal config example per mode with "Next step" links to framework integrations
  • Reference content (TypeTable, createApp internals) already covered in extending/config.mdx
  • Mode helpers preserved but trimmed to essential examples

Test plan

  • Verify start.mdx renders correctly at /start/
  • Verify usage/setup.mdx renders correctly at /usage/setup/
  • Verify old /usage/introduction/ URL returns 404 or redirect
  • Click-test all internal links from the changed files
  • Confirm sidebar shows "Setup & Modes" instead of duplicate "Introduction"

🤖 Generated with Claude Code

Co-Authored-By: Craft Agent agents-noreply@craft.do

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 7, 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
bknd-docs b85c3a8 Commit Preview URL

Branch Preview URL
Feb 07 2026, 11:20 PM

@cameronapak cameronapak merged commit c8ee30b into main Feb 7, 2026
2 checks passed
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