Skip to content

docs: remove Wails/desktop instructions that do not exist - #181

Open
vsolano9 wants to merge 1 commit into
kavix:mainfrom
vsolano9:docs/fix-66-guide-cli-only
Open

docs: remove Wails/desktop instructions that do not exist#181
vsolano9 wants to merge 1 commit into
kavix:mainfrom
vsolano9:docs/fix-66-guide-cli-only

Conversation

@vsolano9

@vsolano9 vsolano9 commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Description

guide.md still describes a Wails native app, a ui/ React/Next.js frontend, and an eko ui command. None of those exist on main. .github/SUPPORT.md links here, so a new user following the first install path hits cd: ui: No such file or directory and then unknown command "ui".

This keeps the CLI walkthrough (init / save / summary / history / restore), which still matches the binary, and replaces the three fictional build options with go build -o eko .. A pointer to docs/docs/cli-reference.md covers the commands the old guide never mentioned (diff, tag, clean, migrate, completion, eko ai).

Related Issues

Resolves #66

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring / Code quality improvement

Technical Details & Architecture Notes

Verified against origin/main at ec12094:

  • git ls-tree has .github, Formula, assets, cmd, deploy, docs, internal. No ui/, no wails.json.
  • rootCmd registers ai, clean, completion, diff, history, init, migrate, restore, save, summary, tag. No ui.
  • The only remaining "Wails" mention in the tree after this change is a leftover comment in .gitignore, which this PR leaves alone.

How Has This Been Tested?

  • Built go build -o eko . from this branch. eko ui exits 1 with unknown command "ui" for "eko".
  • test ! -d ui is true.
  • go test ./... — all packages with tests pass (cmd, internal/ai, internal/api, internal/db, internal/manifest, internal/notify, internal/objects, internal/snapshot, internal/util). Same result as clean main.

The Vercel check is the known fork-authorization failure (Authorization required to deploy). It is unrelated to this docs change; previous merged PRs from this fork had the same check.

Checklist

  • My code follows the style guidelines of this project (run gofmt and go vet)
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (including README.md and CONTRIBUTING.md)
  • My changes generate no new compiler or linter warnings
  • I have added/updated unit tests that prove my fix is effective or that my feature works
  • All new and existing unit tests pass locally with my changes

guide.md told readers to build a Wails desktop app, run `cd ui && npm run build`, and launch `eko ui`. None of that exists: there is no ui/ directory, no Wails config, and no ui subcommand. Keep the working CLI walkthrough and point at the CLI reference for the rest.

Co-authored-by: Cursor <cursoragent@cursor.com>
@vercel

vercel Bot commented Aug 20, 2026

Copy link
Copy Markdown

@vsolano9 is attempting to deploy a commit to the Kavindu's projects Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

guide.md documents a UI/Wails desktop app and diff viewer that don't exist in the repo

1 participant