root/fusion
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(FN-3599): align documentation with delivery process

Browse Source 
Documentation delivery alignment completing Step 5 of FN-3369, updating the CLI reference, research docs, and research hardening preflight guide with consistent documentation delivery guidance across all three files.

Fusion-Task-Id: FN-3599
This commit is contained in:
Fusion
2026-05-06 18:40:05 -07:00
committed by gsxdsm
parent 705e5cc1d3
commit b507e78402
7 changed files with 195 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/cli-reference.md
View File

@@ -93,13 +93,32 @@ fn research retry RR-001 --json
| `fn research cancel <run-id> [--json]` | Request cancellation for an active run. |
| `fn research retry <run-id> [--json]` | Create a new retry run from a `failed`/`timed_out` run when lifecycle marks it retryable. |
Disabled/setup behavior mirrors dashboard and agent surfaces:
- Feature disabled → `FEATURE_DISABLED` (enable project/global research settings)
- Missing credentials → `MISSING_CREDENTIALS` (configure provider auth)
- Provider unavailable or cooldown/rate limit → `PROVIDER_UNAVAILABLE` / `RATE_LIMITED` with retry metadata
- Invalid cancel/retry transitions are reported explicitly (`INVALID_TRANSITION`) with current status context
- Retry budget exhaustion and non-retryable failures are reported explicitly (`RETRY_EXHAUSTED`, `NON_RETRYABLE_PROVIDER_ERROR`)
- Non-retryable failures and invalid state transitions are surfaced as structured errors instead of generic failures
### Research error behavior (`fn research`)
`fn research` returns structured failures with machine-readable codes. The extension/tool-side equivalents are lowercase aliases in payload metadata (`feature-disabled`, `missing-credentials`, `provider-unavailable`, `invalid-transition`, `retry-exhausted`, `non-retryable-provider-error`).
- Feature disabled → `FEATURE_DISABLED` / `feature-disabled`
- Missing credentials → `MISSING_CREDENTIALS` / `missing-credentials`
- Provider unavailable/cooldown → `PROVIDER_UNAVAILABLE` / `provider-unavailable`
- Invalid cancel/retry transition → `INVALID_TRANSITION` / `invalid-transition`
- Retry budget exhausted → `RETRY_EXHAUSTED` / `retry-exhausted`
- Non-retryable provider failure → `NON_RETRYABLE_PROVIDER_ERROR` / `non-retryable-provider-error`
Examples:
```bash
# Feature disabled / setup guard
fn research create --query "compare x y" --json
# Missing credentials / provider unavailable
fn research create --query "latest node lts" --json
# Invalid transition (run already terminal)
fn research cancel RR-001 --json
# Retry exhausted / non-retryable provider error
fn research retry RR-001 --json
```
---