Skip to content

docs: sync with codebase (2026-06-01) #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: sync with codebase (2026-06-01) #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions apps/web/content/getting-started/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ helpbase ships as a scaffolder that creates a standalone Next.js project. No run
<Steps>
<Step title="Run the scaffolder">
```bash
npx create-helpbase my-docs
pnpm dlx helpbase init
```
This creates a new directory with a complete help center project.
This drops the helpbase primitives into your current directory.
</Step>
<Step title="Pick a content source">
The scaffolder asks where to seed content from. Three options:
Expand Down Expand Up @@ -56,13 +56,13 @@ The scaffolded project is completely standalone. It has no dependency on the hel

## Adding to an existing project

If you already have a Next.js + shadcn project, use the registry instead:
If you already have a Next.js + shadcn project, use the command below to add the full helpbase primitive:

```bash
npx shadcn add https://helpbase.dev/r/help-center.json
pnpm dlx helpbase init
```

This adds the help center components, content pipeline, and routes to your existing project without replacing your layout or configuration.
This adds the help center components, content pipeline, and routes to your existing project. You can also install individual pieces (Help center, MCP server, or Sync workflow) from the [/install](/install) page.

## Deploy

Expand Down
5 changes: 2 additions & 3 deletions apps/web/content/getting-started/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,9 @@ Most help center tools are either closed-source hosted SaaS or generic wikis tha

<Steps>
<Step title="Scaffold a new project">
Run the scaffolder to create a new help center project with sample content:
Run the initializer to drop the helpbase primitive into your project:
```bash
npx create-helpbase my-docs
cd my-docs
pnpm dlx helpbase init
```
</Step>
<Step title="Start the dev server">
Expand Down