docs(open-knowledge): surface the cross-platform web-app install path#207
Merged
Conversation
… (#1790) * docs(open-knowledge): surface the cross-platform web-app install path Make the web app (launched via the npm `ok` CLI) a first-class, discoverable install path for users on Linux, Intel Macs, and Windows, without diluting the macOS desktop app as the recommended path. - Quickstart: the install step now tabs `macOS app` (default) vs `Web app` (npm install -g + ok init + ok start --open); fix the self-contradictory prereqs callout and the macOS-only git hint. - Overview: reframe the "native macOS app" opening to acknowledge the web app. - McpInstall component: present BOTH wiring paths (desktop consent dialog AND `ok init`), fixing the Claude Code / Cursor / Codex integration pages at once. - Integrations: remove the stale "Open with AI hidden in the web build" claim (the web app has it via a `/api/spawn-cursor` + claude.ai fallback). - reference/cli reframed as the "CLI & web app" guide; Linux stated supported (advisory cli-e2e), Windows untested-but-expected per CLAUDE.md. - New packages/cli/README.md (the npm landing page) + an end-user Install section in the public overlay README. - Cross-link the web-app guide from overview, quickstart, and share. Docs-only; no published behavior change (no changeset). Spec + rationale: public/open-knowledge/specs/2026-06-10-cli-only-install-docs/ * docs(open-knowledge): address claude[bot] review — web path for the Tech IPOs example - Quickstart: the recommended "Tech IPOs" example tab fired a macOS-only deep link that dead-ended Linux/Windows/Intel users. Add an `ok clone https://github.com/inkeep/tech-ipos` + `ok start --open` terminal alternative inside that tab. - Quickstart: reword the Web-tab bridging line so it stops forward-referencing desktop-only terms ("Pick Project", "consent dialog") web users haven't seen. - cli.mdx: align "Node.js ≥24" → "Node.js 24+" (matches quickstart + both READMEs) and link nodejs.org. * docs(open-knowledge): consistency polish from claude[bot] re-review - Standardize on "web app" (two words) in mcp-install.tsx + the quickstart consent callout (was "web-app", mismatching the "CLI & web app" page title). - Align the platform triple to "Linux, Windows, or an Intel Mac" in cli.mdx + share.mdx (the Web-tab intro keeps Windows last so its "unverified" caveat reads naturally). - Complete the step-2 web-app pattern: add `ok init` / `ok start --open` notes to the "Your own repo" and "New project" tabs, parallel to the Tech IPOs tab. All three were non-blocking "Consider" items; the prior commit cleared the blocking findings. The mirror-runnable failure on 58e0daf was a bun-install --frozen-lockfile 600s timeout (known CI flake), not a content issue. * docs(open-knowledge): drop the unverified-Windows hedge from the CLI page prereqs * docs(open-knowledge): rebuild quickstart as a platform toggle (desktop / web app) Re-applies the cross-platform install path onto the rewritten upstream quickstart (#1935): a single `macOS app` / `Web app` tab selection at the top drives two self-contained walkthroughs, eliminating every inline "on the web app?" conditional. Per-tab prerequisites. The macOS walkthrough preserves the upstream desktop flow verbatim; the web walkthrough uses npm + `ok init` + `ok start --open`. The shared tail (open-in-agent / watch / explore) is duplicated per platform for an unbroken read. * docs(open-knowledge): align Node notation + "Claude Code" naming (review nits) - quickstart.mdx: macOS-tab prereq "Node.js ≥24" → "24+" to match the web tab and the rest of the PR (the ≥24 form was inherited from the upstream rewrite). - cli.mdx: "(Claude, Cursor, Codex)" → "(Claude Code, Cursor, Codex)". * docs(open-knowledge): drop the Node prereq from the macOS quickstart tab The desktop app bundles its own runtime, so Node.js isn't a user prerequisite for the macOS path. The web-app tab keeps it. * docs(open-knowledge): trim integration + CLI copy - claude-code.mdx: drop the "— the desktop app or the web app, whichever you're running" clause from the live-editing line. - cli.mdx: remove the platform line from the prereqs callout (the page intro already states the platforms); "nuke all servers" → "stop all servers". * docs(open-knowledge): flush quickstart tabs + fix share-page accuracy - Add `.ok-flush-tabs` (global.css) and apply it to the quickstart install `<Tabs>`: strips Fumadocs' tab card (outer border, secondary bg, inner panel bg + padding) so the tab content flows flush with the page and the <Steps> rail is the only left line. Keeps a hairline under the trigger row. - share.mdx: drop the "(install the web app instead)" parenthetical — the share splash page only offers the desktop deep link + the macOS DMG, with no web-app affordance, so the note was misleading. * docs(open-knowledge): emphasize quickstart tabs (~H2) + space below the row Bump the install tab labels to ~1.5rem / semibold (active 700) so the platform choice reads as a primary decision, and add 1.5rem spacing below the tab row. * docs(open-knowledge): dial quickstart tab size 1.5rem -> 1rem * docs(open-knowledge): fix web-tab delete copy, drop dead CSS, naming nit - quickstart web tab: remove "(to Trash)" from the delete affordance — the web app deletes via POST /api/delete-path (permanent), not OS Trash. The macOS desktop tab keeps "(to Trash)" (Electron shell.trashItem). - global.css: remove the now-dead `.ok-route-tabs` block (no call sites after the quickstart rebuild). - claude-code.mdx: "ask Claude" -> "ask Claude Code". * docs(open-knowledge): Windows not yet supported (showstopper bugs found) Reverses the earlier "untested-but-likely" stance (spec D6). Drops Windows from every web-app platform list (overview, quickstart tab label, cli.mdx, McpInstall, both READMEs) — the web app is Linux + Intel Mac — and adds an explicit "Windows isn't supported yet" callout to the quickstart Web tab and the CLI & web app guide, plus a parenthetical on the npm/GitHub READMEs. * docs(open-knowledge): drop the "Windows isn't supported yet" callout Remove the warn callout from the CLI guide and the quickstart Web tab; Windows is still omitted from every platform list (and noted parenthetically on the READMEs). --------- GitOrigin-RevId: 1871202dd15ef30c1fb988431d1c723db9d59f45
![inkeep-internal-ci[bot]](https://avatars.githubusercontent.com/u/123133689?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Automated approval from agents-private public-mirror-sync (run: https://github.com/inkeep/agents-private/actions/runs/27787778104). Source of truth is the monorepo; direct edits on inkeep/open-knowledge are overwritten on next sync.
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
1 participant
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.
No description provided.