Skip to content
Open
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
6dccdc8
docs: clarify that workspace name derives the Kubernetes namespace
May 27, 2026
68154db
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] May 27, 2026
eeb5cd1
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] May 28, 2026
472c0db
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 15, 2026
edf56b3
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 15, 2026
d86b71a
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 15, 2026
d3d5916
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 15, 2026
417072d
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 15, 2026
deebd23
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 15, 2026
6b8bfd9
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 15, 2026
d53553a
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 16, 2026
a6bd72b
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 16, 2026
a1909be
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 16, 2026
70d888c
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 20, 2026
0f458a0
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 20, 2026
38ebf0c
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jun 20, 2026
06b9350
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 1, 2026
6825799
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 1, 2026
98c1c6e
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 1, 2026
ed0ad1a
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 3, 2026
072cdf2
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 3, 2026
84c72cc
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 3, 2026
a242d38
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 10, 2026
944dea4
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 10, 2026
c46e373
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 10, 2026
dcfaf96
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 16, 2026
7b31be1
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 16, 2026
456ab2f
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 21, 2026
15136fb
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 21, 2026
c5b9057
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 22, 2026
02e91da
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 22, 2026
21ee879
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 22, 2026
2e9e19d
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 28, 2026
c9c5afe
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 28, 2026
db7bee3
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Jul 28, 2026
14be4df
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Aug 5, 2026
fd3117a
Merge branch 'main' into 05270555-fix-workspace-name-docs
mergify[bot] Aug 5, 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
25 changes: 23 additions & 2 deletions docs/src/content/docs/concepts/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,31 @@ Open the platform UI and click **New Workspace**. You will be prompted for:

| Field | Purpose |
|-------|---------|
| **Display name** | A human-readable label shown across the UI. |
| **Workspace Name** | A human-readable label shown across the UI. The platform also derives the internal **project name** from this value (see [Workspace name and project name](#workspace-name-and-project-name) below). |
| **Description** | Optional notes describing what the workspace is for. |

After creation you land on the workspace dashboard, where you can start sessions, configure integrations, and invite collaborators.

## Workspace name and project name

When you create a workspace the platform derives a **project name** from the workspace name you enter. This project name becomes the Kubernetes namespace for the workspace and is the identifier used in API paths, RBAC bindings, and CLI commands.

The derivation rules (implemented in `generateWorkspaceName` in the frontend) are:

1. Convert to lowercase.
2. Replace whitespace with hyphens.
3. Strip characters that are not lowercase alphanumeric or hyphens.
4. Collapse consecutive hyphens and trim leading/trailing hyphens.
5. Truncate to 63 characters (the Kubernetes namespace name limit).

For example, a workspace name of **"My Research Workspace"** produces the project name `my-research-workspace`.

:::caution
The project name must be **globally unique** on the cluster — no two workspaces can share the same derived name. If you try to create a workspace whose name collides with an existing namespace, the platform returns a **409 Conflict** error. Choose a distinctive workspace name to avoid collisions.
:::

The project name **cannot be changed** after creation because it is the Kubernetes namespace and is referenced by RBAC bindings, secrets, and session resources.

## Workspace settings

Each workspace carries its own configuration. Open **Settings** from the workspace sidebar to adjust the following.
Expand All @@ -30,7 +50,8 @@ Each workspace carries its own configuration. Open **Settings** from the workspa

### General

- **Display name and description** -- Update at any time.
- **Workspace name (display name) and description** -- Update at any time.
- **Project name** -- The Kubernetes namespace for this workspace. Read-only after creation (see [Workspace name and project name](#workspace-name-and-project-name)).
Comment thread
coderabbitai[bot] marked this conversation as resolved.

### Storage

Expand Down