Skip to content

[nightshift] doc-drift: 17 documentation/code mismatches found #15

@nightshift-micr

Description

@nightshift-micr

Documentation Drift Analysis: opencode-studio

Executive Summary

Analysis of the opencode-studio codebase (Next.js 16 + Express GUI for managing OpenCode configurations) reveals 17 documentation drift findings across severity levels P0–P3. The most critical issues are: 3 client API calls that hit non-existent server endpoints (causing runtime failures for URL import, bulk import, and plugin config deletion), duplicate TypeScript interface declarations that shadow earlier definitions, and a deep link security mismatch where the README documents cmd and env parameters that were intentionally disabled in the CLI for security reasons.

Severity Count
P0 (Critical) 3
P1 (High) 4
P2 (Medium) 6
P3 (Low) 4

Findings Table

# Severity File Line(s) Description Recommendation
1 P0 client-next/src/lib/api.ts 413, 433 Client calls POST /api/fetch-url and POST /api/bulk-fetch — neither endpoint exists in server/index.js. Will fail at runtime. Add missing server endpoints, or remove dead client code.
2 P0 client-next/src/lib/api.ts 477 Client calls DELETE /api/plugins/config/:name — no matching route on server. Add DELETE route to server, or remove client call.
3 P0 client-next/src/types/index.ts 64, 469 AgentInfo interface declared twice — second shadows first, losing fields. Remove duplicate declaration or merge both.
4 P1 README.md 123, 145 Deep link docs show cmd and env params disabled for security in cli.js:61-68. Update README to show only name param.
5 P1 client-next/src/types/index.ts 341, 347, 476, 482 RulesResponse and SystemToolInfo declared twice with different shapes. Consolidate to single declarations.
6 P1 CHANGELOG.md 5-61 Duplicate and misordered version entries. Deduplicate and sort chronologically.
7 P1 CHANGELOG.md (missing) No entry for current version 1.17.0. Add [1.17.0] changelog entry.
8 P2 README.md 86-96 Route table missing 6 pages that exist in sidebar. Add missing routes.
9 P2 README.md 51-62 Feature list missing 10+ major features. Add missing features.
10 P2 server/README.md 29-34 Server README lists only 4 features but server has 87+ API routes. Update to reflect full feature set.
11 P2 client-next/README.md 1-33 Client README lists 5 features, missing agents/logs/rules/profiles. Also claims "Geist font" but uses IBM Plex Mono. Update feature list and font claim.
12 P2 README.md 68-75 Architecture diagram oversimplified, missing key data paths. Update diagram.
13 P3 server/README.md 27 Says "runs on port 1920" without mentioning auto-detection. Add "auto-detects next available".
14 P3 server/index.js 3343-3346 Duplicate section comment. Remove duplicate.
15 P3 server/index.js 4637-4667 Routes registered after module.exports. Move routes above export.
16 P3 README.md 157-159 Confirmation dialog scope unclear (web UI only). Clarify scope.
17 P2 CHANGELOG.md 8 Says MIN_SERVER_VERSION bumped to 2.2.0 but client now requires 2.2.2. Update CHANGELOG.

Automated by Nightshift v3 (GLM 5.1)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions