Skip to content

Commit e44a376

Browse files
committed
docs: mark custom prompts and tools as experimental and unsupported
Add disclaimers to prompts, tools, and configuration documentation noting that custom prompt and tool configuration is experimental. Bugs with the ingestor, reviewer, and core tooling should still be filed, but custom prompt debugging and token consumption issues from custom configurations are not supported. Assisted-by: claude-opus-4.6 Signed-off-by: derekbarbosa <derekasobrab@gmail.com>
1 parent b37acc1 commit e44a376

4 files changed

Lines changed: 19 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ cd sashiko
9191
Copy an example config to get started. For a full reference of every
9292
setting, see the [Configuration Reference](docs/configuration.md).
9393

94-
Optional customization sections:
94+
Optional customization sections (experimental -- see linked docs for support policy):
9595
* **Tools**: Configure which AI tools are enabled (optional). See [docs/tools.md](docs/tools.md) for details.
9696
* **Prompts**: Customize review stages and prompts (optional). See [docs/prompts.md](docs/prompts.md) for details.
9797

docs/configuration.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,9 @@ Optional array of additional git remotes to track.
154154
| `max_total_tokens` | integer | `5000000` | Maximum cumulative uncached tokens (input + output) per review. Cached tokens are excluded. Set to 0 to disable. |
155155
| `max_total_output_tokens` | integer | `500000` | Maximum cumulative output tokens per review. Set to 0 to disable. |
156156

157-
### `[tools]` (optional)
157+
### `[tools]` (optional, experimental)
158+
159+
> **Experimental / Unsupported** -- see [AI Tools](tools.md) for details.
158160
159161
Configure which AI tools are available during review. See [AI Tools](tools.md) for full documentation.
160162

@@ -164,7 +166,9 @@ Configure which AI tools are available during review. See [AI Tools](tools.md) f
164166
| `disabled` | list | `[]` | Denylist of tool names. Takes precedence over `enabled`. |
165167
| `custom` | list | `[]` | Custom shell-based tool definitions. |
166168

167-
### `[prompts]` (optional)
169+
### `[prompts]` (optional, experimental)
170+
171+
> **Experimental / Unsupported** -- see [Prompt Customization](prompts.md) for details.
168172
169173
Customize review prompts and stages. See [Prompt Customization](prompts.md) for full documentation.
170174

docs/prompts.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Prompt Customization
22

3+
> **Experimental / Unsupported:** Custom prompt configuration is experimental
4+
> and provided as-is. Bugs and issues with the Sashiko ingestor, reviewer, or
5+
> core tooling can and should still be filed. However, we will not provide
6+
> support for debugging custom prompts or troubleshooting token consumption
7+
> caused by custom prompt configurations.
8+
39
Sashiko's multi-stage review pipeline loads its prompts from a
410
configurable directory. You can override prompt content, reorder or
511
disable stages, define template variables, and point to a remote prompt

docs/tools.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# AI Tools
22

3+
> **Experimental / Unsupported:** Custom tool configuration is experimental
4+
> and provided as-is. Bugs and issues with the Sashiko ingestor, reviewer, or
5+
> core tooling can and should still be filed. However, we will not provide
6+
> support for debugging custom tool definitions or troubleshooting token
7+
> consumption caused by custom tool configurations.
8+
39
Sashiko gives the AI reviewer a set of built-in tools for navigating the
410
codebase under review. All built-in tools are enabled by default; you can
511
restrict or extend them via `Settings.toml`.

0 commit comments

Comments
 (0)