docs: drop the okf serve promise, #40's live server is abandoned - #83
Merged
Conversation
The live-server half of #40 is dropped: interactive, always-fresh viewing is being pursued as the VS Code extension already on the roadmap, which reaches the same goal from inside the editor without a local HTTP server -- and reaches full-text search by the same route, since an extension host is a process that can call the .NET side rather than mirroring ConceptSearch's weights in JavaScript. What the server would have added over okf-render alone was one saved command invocation per edit. Search was the only capability that genuinely required it, and the extension gets that too. Four places promised `okf serve` or an open live-server half and would have outlived the decision: ROADMAP's viewer entry, the VS Code entry's cross-reference to it, CHANGELOG's unreleased okf-render bullet, README's render section, and CLAUDE.md's viewer architecture bullet. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
🟢 Approval recommended
The changes are documentation-only and consistently remove the now-abandoned okf serve promise without impacting code behavior.
Pull request overview
This PR updates project documentation to reflect that a local live server (okf serve) is no longer planned, and that interactive viewing + full-text search are instead expected to come via a VS Code extension (closing #40 accordingly).
Changes:
- Remove/replace roadmap and docs language that implied the live-server half of #40 was still open.
- Clarify that
okf-rendergenerates a static site with no full-text search (to avoid forkingConceptSearchscoring into JavaScript). - Align architectural guidance in
CLAUDE.mdwith the “nookf serveplanned” decision.
File summaries
| File | Description |
|---|---|
| ROADMAP.md | Updates roadmap entries to state the live-server half of #40 is dropped and positions the VS Code extension as the path to interactive viewing/search. |
| README.md | Removes the “planned okf serve companion” promise and explains why static sites don’t include full-text search. |
| CLAUDE.md | Updates the viewer architecture section to explicitly state okf serve is not planned and reiterates the process/scoring rationale. |
| CHANGELOG.md | Removes the “search lands with okf serve” statement and replaces it with the static-site/search rationale. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+81
to
+83
| decorative text. No full-text search: a static site has no server to run | ||
| the shared `ConceptSearch` scorer, and mirroring its weights in JavaScript | ||
| would fork it. (This started life as `okf`'s `render` verb; it |
Comment on lines
+262
to
+264
| no server needed. It is read-only, and has no full-text search: a static site | ||
| has no server to run the shared `ConceptSearch` scorer, and mirroring its | ||
| weights in JavaScript would fork it. Interactive browsing with search is |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #40.
The live-server half of #40 is dropped. Interactive, always-fresh viewing is being pursued as the VS Code extension already on the roadmap instead: it reaches the same goal from inside the editor without a local HTTP server, and reaches full-text search by the same route — an extension host is a process, so it can call the .NET side rather than mirroring
ConceptSearch's weights in JavaScript.The reasoning that settled it: what a server would have added over
okf-renderalone was one saved command invocation per edit. Search was the only capability that genuinely required a process in the loop, and the extension provides one.Why this is a docs PR
Five statements across four files promised
okf serveor described the live-server half as open, and would have outlived the decision:ROADMAP.md— the bundle-viewer entry said the live-server half "remains open", with its implementation approach still to be chosenROADMAP.md— the VS Code extension entry cross-referenced "the live-server half of Feature request: OKF bundle viewer (static render + local live server) #40 above" as sharing plumbing with itCHANGELOG.md— the unreleasedokf-renderbullet said search "lands with the plannedokf servecompanion"README.md— the render section said the sameCLAUDE.md— the viewer architecture bullet said "search lands with the plannedokf serve"Each now states what is actually true: no full-text search in a static site because there is no process to run the shared scorer in, and no
okf serveis planned.Verified: 1272 tests green,
dotnet formatclean, no remainingokf servereference outside historical design docs underdocs/superpowers/.🤖 Generated with Claude Code