Skip to content

docs: add deployment path selector, first successful outcome steps, resolve auth/sizing contradictions, and clean FAQ #824

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

Merged
blue4209211 merged 4 commits into from
Aug 22, 2026
Merged

docs: add deployment path selector, first successful outcome steps, resolve auth/sizing contradictions, and clean FAQ #824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
23d5279
docs: add deployment path selector, first-value outcome verification …
blue4209211 Aug 22, 2026
adef745
docs: resolve licensing, authentication, sizing, telemetry, and onboa…
blue4209211 Aug 22, 2026
9a3c6e3
docs: finalize sizing agreement, integration requirement labels, pref…
blue4209211 Aug 22, 2026
e2ba179
docs: synchronize Quick Start table with Server -> BYOM -> Agent sequ…
blue4209211 Aug 22, 2026
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
52 changes: 24 additions & 28 deletions doc-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,37 @@
# Website
# NudgeBee Documentation

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
This repository hosts the official documentation for [NudgeBee](https://nudgebee.com), built using [Docusaurus 3](https://docusaurus.io/).

### Installation
## Prerequisites

```
$ npm install
```
- **Node.js**: v18.0.0 or higher
- **npm**: v9.0.0 or higher

### Local Development
## Local Development

```
$ npm start
```
1. **Install dependencies**:
```bash
npm install
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
2. **Start the local dev server**:
```bash
npm start
```
This command starts the local development server at `http://localhost:3000` (or `http://localhost:4000`). Edits in `docs/` reflect live via hot-reloading.

### Build

```
$ npm run build
```
## Production Build

This command generates static content into the `build` directory and can be served using any static contents hosting service.
To verify and generate static assets:

### Deployment

Using SSH:

```
$ USE_SSH=true npm run deploy
```bash
npm run build
```

Not using SSH:
The compiled output will be generated inside the `build/` directory.

```
$ GIT_USER=<Your GitHub username> npm run deploy
```
To preview the production build locally:

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
```bash
npm run serve
```
124 changes: 53 additions & 71 deletions doc-server/docs/FAQ.md
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 3 additions & 7 deletions doc-server/docs/editions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ documentation — this page is the source of truth for what each one includes.

| | **Community** <Community/> | **Enterprise** <Enterprise/> | **Cloud** <Cloud/> |
|---|---|---|---|
| **What it is** | Free self-hosted edition. Server is licensed under **BSL 1.1**; Agents are **Apache 2.0**. Fully functional. | Self-hosted with a commercial license. Adds enterprise features and SLA support. | Fully managed SaaS, hosted and operated by NudgeBee. |
| **What it is** | Free, source-available self-hosted edition. The Server is licensed under **BSL 1.1** (converting to Apache 2.0 on change date); Agents are **Apache 2.0**. | Self-hosted with a commercial license. Adds enterprise features, SAML SSO, and SLA support. | Fully managed SaaS, hosted and operated by NudgeBee. |
| **Where it runs** | Your own Kubernetes cluster | Your own Kubernetes cluster | [app.nudgebee.com](https://app.nudgebee.com) |
| **Container images** | Public — `ghcr.io/nudgebee` (no authentication) | Licensed — `registry.nudgebee.com` | Managed for you |
| **License key** | Not required | Required | Managed in cloud account |
Expand All @@ -19,16 +19,12 @@ documentation — this page is the source of truth for what each one includes.
| **Support** | Community ([GitHub Issues & Discussions](https://github.com/nudgebee)) | Commercial support (SLA) | Commercial support (SLA) |

:::tip
Not sure where to start? The **Community** edition is fully functional and free
— monitoring, the Semantic Knowledge Graph, cost optimizations, troubleshooting,
the Workflow Builder, and Autopilot all work out of the box. You can move to
Enterprise or Cloud later without losing your configuration.
Not sure where to start? The **Community** edition is a production-capable self-hosted edition containing the complete core monitoring, troubleshooting, optimization, workflow, and BYOM experience — the Semantic Knowledge Graph, cost optimizations, alerting, the Workflow Builder, and Autopilot all work out of the box. You can move to Enterprise or Cloud later without losing your configuration.
:::

## What's in the Community edition

The Community edition is **fully functional** for self-hosted Kubernetes
operations. It includes:
The Community edition provides a comprehensive foundation for self-hosted Kubernetes operations. It includes:

- The NudgeBee **Server** (control plane, UI, API) and **Agent**
- The **Semantic Knowledge Graph**
Expand Down
Loading
Loading