mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-11 05:11:49 +01:00
docs: add experimental feature caveats
Co-Authored-By: Paperclip <noreply@paperclip.ing>
This commit is contained in:
1 parent
c80d1e55ed
commit
158b3e1acd
4 files changed
+66
No files matched your search
@@ -676,6 +676,8 @@ pnpm paperclipai llm agent-configuration:adapter <adapter-type>
|
||||
pnpm paperclipai llm agent-icons
|
||||
```
|
||||
|
||||
Experimental features are opt-in and are provided without compatibility guarantees. They may break, change, or be removed at any time. Use them at your own risk.
|
||||
|
||||
## Adapter, Asset, And Skill Commands
|
||||
|
||||
```sh
|
||||
|
||||
@@ -134,6 +134,17 @@ pnpm paperclipai activity list [--agent-id <id>] [--entity-type issue] [--entity
|
||||
pnpm paperclipai dashboard get
|
||||
```
|
||||
|
||||
## Instance Settings
|
||||
|
||||
```sh
|
||||
pnpm paperclipai instance settings:general
|
||||
pnpm paperclipai instance settings:general:update --payload-json '{...}'
|
||||
pnpm paperclipai instance settings:experimental
|
||||
pnpm paperclipai instance settings:experimental:update --payload-json '{...}'
|
||||
```
|
||||
|
||||
Experimental features are opt-in and are provided without compatibility guarantees. They may break, change, or be removed at any time. Use them at your own risk.
|
||||
|
||||
## Heartbeat
|
||||
|
||||
```sh
|
||||
|
||||
@@ -50,6 +50,7 @@
|
||||
"guides/board-operator/delegation",
|
||||
"guides/board-operator/execution-workspaces-and-runtime-services",
|
||||
"guides/board-operator/delegation",
|
||||
"guides/board-operator/experimental-features",
|
||||
"guides/board-operator/approvals",
|
||||
"guides/board-operator/costs-and-budgets",
|
||||
"guides/board-operator/activity-log",
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: Experimental Features
|
||||
summary: What Paperclip experimental features mean for board operators
|
||||
---
|
||||
|
||||
Experimental features are opt-in and are provided without compatibility guarantees. They may break, change, or be removed at any time. Use them at your own risk.
|
||||
|
||||
## What "experimental" means
|
||||
|
||||
When a feature is marked experimental, Paperclip is still evaluating the product shape and implementation details.
|
||||
|
||||
- The feature is not part of the stable operator contract yet.
|
||||
- UI, API, CLI, behavior, and stored configuration may change as the feature evolves.
|
||||
- Paperclip does not promise compatibility, rollback, migration, or long-term support for experimental features.
|
||||
|
||||
If you need stable behavior for an important workflow, do not rely on an experimental feature.
|
||||
|
||||
## Where you enable them
|
||||
|
||||
Board operators enable or disable experiments from **Instance Settings > Experimental** in the app.
|
||||
|
||||
The CLI exposes the same surface:
|
||||
|
||||
```sh
|
||||
pnpm paperclipai instance settings:experimental
|
||||
pnpm paperclipai instance settings:experimental:update --payload-json '{...}'
|
||||
```
|
||||
|
||||
Those commands change the same opt-in settings that the UI manages.
|
||||
|
||||
## When to use them
|
||||
|
||||
Experimental features are best used when you are:
|
||||
|
||||
- evaluating a new capability before wider rollout
|
||||
- testing a non-critical workflow
|
||||
- comfortable with behavior changes between releases
|
||||
- prepared to stop using the feature if it changes or disappears
|
||||
|
||||
## Operator expectations
|
||||
|
||||
Before enabling an experimental feature:
|
||||
|
||||
- decide whether the workflow can tolerate breakage or churn
|
||||
- avoid making the feature a dependency for stable production processes
|
||||
- keep the scope small until you understand how the feature behaves in your company
|
||||
- watch release notes and docs for changes to the feature contract
|
||||
|
||||
## Related references
|
||||
|
||||
- See the CLI caveat in [Control-Plane Commands](/cli/control-plane-commands).
|
||||
- See the repo CLI reference in [`doc/CLI.md`](https://github.com/paperclipai/paperclip/blob/master/doc/CLI.md) when working from the repository.
|
||||
Reference in new issue
Block a user