Skip to content

Commit 7e257e0

Browse files
alari76claude
andauthored
docs: fix accuracy drift surfaced by docs audit (#489)
* docs: fix accuracy drift surfaced by docs audit - WORKFLOWS.md: correct stale workflow output dirs to .codekin/reports/<topic>, fix "nine" -> "ten" built-in count, refresh outputDir example - API-REFERENCE.md: add Opus 4.8 to models table; update example model values - FEATURES.md: replace stale cc-web naming with Codekin, add missing pr-review workflow, drop shipped-date marker, refresh outputDir examples - README.md: document missing `codekin stop` command Co-Authored-By: Claude Opus 4 <noreply@anthropic.com> * docs: consolidate docs/operations/ into a single Operations Guide Merge the two orphaned (zero inbound links) nested files — ws-rate-limit.md and workflow-resilience.md — into docs/OPERATIONS.md with a table of contents, removing the docs/operations/ subdirectory. Link it from SETUP.md so it is actually discoverable. Relative source links adjusted for the new location; content preserved verbatim. Co-Authored-By: Claude Opus 4 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4 <noreply@anthropic.com>
1 parent d9795b1 commit 7e257e0

8 files changed

Lines changed: 332 additions & 341 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ codekin service status # Check whether the service is running
4141
codekin service install # (Re-)install the background service
4242
codekin service uninstall # Remove the background service
4343
codekin start # Run in foreground (for debugging)
44+
codekin stop # Stop the running background service
4445
codekin setup --regenerate # Generate a new auth token
4546
codekin upgrade # Upgrade to latest version
4647
codekin uninstall # Remove Codekin entirely

docs/API-REFERENCE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ Endpoints that accept a `model` field (e.g. session creation via WebSocket, work
7474

7575
| Identifier | Label |
7676
|---|---|
77+
| `claude-opus-4-8` | Opus 4.8 |
7778
| `claude-opus-4-7` | Opus 4.7 |
7879
| `claude-opus-4-6` | Opus 4.6 |
7980
| `claude-sonnet-4-6` | Sonnet 4.6 |
@@ -487,7 +488,7 @@ Add a repo workflow configuration.
487488

488489
`repoPath` is resolved via `realpath` and must sit under the configured `REPOS_ROOT` — otherwise the request is rejected with `400`.
489490

490-
**Request body:** `{ "id": "...", "name": "...", "repoPath": "...", "cronExpression": "...", "enabled": true, "customPrompt": "...", "kind": "...", "model": "claude-opus-4-7" }` (see [Models](#models) for accepted identifiers)
491+
**Request body:** `{ "id": "...", "name": "...", "repoPath": "...", "cronExpression": "...", "enabled": true, "customPrompt": "...", "kind": "...", "model": "claude-opus-4-8" }` (see [Models](#models) for accepted identifiers)
491492
**Response:** `{ "config": WorkflowConfig, "webhookSetup"?: WebhookSetupResult }`, or `400` with `{ "error": "..." }` when required fields are missing, `provider` is invalid, or `repoPath` is not an existing directory under the configured repos root.
492493

493494
### `PATCH /api/workflows/config/repos/:id`
@@ -555,7 +556,7 @@ Spawn a new child session for a task. `repo` is resolved via `realpath` and must
555556

556557
Because each spawn allocates a real Claude subprocess, this endpoint is additionally **rate-limited per client IP**: at most **20 spawn requests per 5-minute sliding window per IP**. The limiter is keyed on `req.ip` (which honours `X-Forwarded-For` when the server is configured with `TRUST_PROXY`) and runs *before* auth, so even unauthenticated floods are capped. It is applied on top of the global 300-requests-per-minute API limiter.
557558

558-
**Request body:** `{ "repo": "...", "task": "...", "branchName": "...", "useWorktree"?: boolean, "completionPolicy"?: "pr" | "merge" | "commit-only", "deployAfter"?: boolean, "model"?: "claude-opus-4-7", "allowedTools"?: string[] }` (see [Models](#models) for accepted `model` identifiers)
559+
**Request body:** `{ "repo": "...", "task": "...", "branchName": "...", "useWorktree"?: boolean, "completionPolicy"?: "pr" | "merge" | "commit-only", "deployAfter"?: boolean, "model"?: "claude-opus-4-8", "allowedTools"?: string[] }` (see [Models](#models) for accepted `model` identifiers)
559560
**Response:** `{ "child": ChildSession }`, `400` with `{ "error": "..." }` when required fields are missing, `branchName` / `allowedTools` fail validation, or `repo` is not an existing directory under the configured repos root, `429` with `{ "error": "Too Many Requests", "retryAfter": 300 }` when the per-IP spawn cap is exceeded (`retryAfter` is in seconds), or `503` when the child session cannot be spawned.
560561

561562
#### `GET /api/orchestrator/children/:id`

docs/FEATURES.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -182,19 +182,18 @@ Codekin can run scheduled Claude Code sessions against repositories to produce s
182182
- `docs-audit.weekly` — Weekly audit of documentation accuracy, staleness, and coverage
183183
- `commit-review` — Event-driven review of the most recent commit for correctness, security, and performance
184184
- `repo-health.weekly` — Weekly repository health assessment covering dead code, TODOs, config drift, license compliance, and git hygiene
185+
- `pr-review` — Event-driven review of pull requests, posting findings directly to the PR as review comments (see [PR Review Automation](#pr-review-automation))
185186
- **Per-repo overrides** — Any workflow's prompt can be customized for a specific repo by placing a `.codekin/workflows/{kind}.md` file in the repo. The override prompt replaces the global one at run time.
186187
- **MD-based definitions** — Workflow types are defined as Markdown files with YAML frontmatter in `server/workflows/`. New workflow types can be added by dropping a `.md` file there — no code changes needed.
187188
- **Staleness check** — Workflows accept a `sinceTimestamp` parameter; if no commits have been made since the last run, the workflow is skipped automatically.
188-
- **Auto-committed reports** — Output is saved to a configurable directory within the repo (e.g. `review logs/`, `security-reports/`) and committed with a configurable message.
189+
- **Auto-committed reports** — Output is saved to a configurable directory within the repo (e.g. `.codekin/reports/code-review/`, `.codekin/reports/security/`) and committed with a configurable message.
189190

190191
See [docs/WORKFLOWS.md](./WORKFLOWS.md) for the full workflow definition format, frontmatter field reference, and instructions for writing per-repo overrides.
191192

192193
---
193194

194195
## PR Review Automation
195196

196-
**Shipped**: 2026-04-10
197-
198197
Codekin automatically reviews pull requests by responding to GitHub webhook events. When a PR is opened, updated, or marked ready for review, a Claude session is spawned to analyze the diff and post findings directly to the PR.
199198

200199
- **Event-driven** — Triggered by `pull_request` webhook events (opened, synchronize, reopened, ready_for_review). No polling or manual invocation required.
@@ -327,7 +326,7 @@ A per-session registry that remembers which tools and commands have been approve
327326

328327
## Settings & Configuration
329328

330-
- **Authentication token** — Enter your cc-web token in the Settings modal. The token is validated in real time with a checkmark (valid) or cross (invalid) indicator.
329+
- **Authentication token** — Enter your Codekin token in the Settings modal. The token is validated in real time with a checkmark (valid) or cross (invalid) indicator.
331330
- **Font size** — Adjustable from 10px to 24px via a slider in Settings.
332331
- **Persistent** — Settings are stored in `localStorage` under the key `codekin-settings`.
333332
- **Auto-open** — The Settings modal opens automatically on first visit when no token is configured.
@@ -396,7 +395,7 @@ Browser (React SPA)
396395
↕ WebSocket + REST
397396
nginx (port 443, HTTPS)
398397
├── / → Static files (web root)
399-
└── /cc/ → cc-web server (port 32352) — WebSocket + REST + uploads
398+
└── /cc/ → Codekin server (port 32352) — WebSocket + REST + uploads
400399
401400
Claude Code CLI
402401
(spawned per-session with stream-json format)
@@ -407,7 +406,7 @@ nginx (port 443, HTTPS)
407406
| Service | Port | Role |
408407
|---|---|---|
409408
| nginx | 443 | Reverse proxy, SSL termination, Authelia auth |
410-
| cc-web server | 32352 | Session management, Claude process lifecycle, real-time streaming, file uploads, repository listing |
409+
| Codekin server | 32352 | Session management, Claude process lifecycle, real-time streaming, file uploads, repository listing |
411410

412411
### Technology Stack
413412

0 commit comments

Comments
 (0)