anomalyco/opencode
1
0
Fork 0
mirror of https://github.com/anomalyco/opencode.git synced 2026-07-22 18:25:32 -04:00
Code Issues 5.9k Packages Projects Releases 19 Wiki Activity

Desktop Application Documentation is an Utter Disaster - A Comedy of Errors -- Prompt "open an accurate, but scathing opencode issue about how theres no documentation for the desktop application" #8849

New Issue
Open
opened 2026-02-16 18:11:00 -05:00 by yindo · 1 comment
yindo commented 2026-02-16 18:11:00 -05:00
Owner
Copy Link
Copy Source

Originally created by @dl-alexandre on GitHub (Feb 8, 2026).

Originally assigned to: @jayair on GitHub.

The Problem

Let me be crystal clear about the absolutely abysmal state of OpenCode's desktop application documentation. This isn't just 'missing documentation' - this is a comprehensive documentation failure that borders on intentional sabotage of your own project.

The Evidence

1. The Desktop README is a Joke

The packages/desktop/README.md contains exactly 4 lines of actual useful information:

  • bun install
  • bun run --cwd packages/desktop tauri dev
  • bun run --cwd packages/desktop dev
  • bun run --cwd packages/desktop tauri build

That's it. No environment setup. No troubleshooting. No prerequisites beyond a vague 'see Tauri prerequisites' link. This is documentation for noobs by noobs.

2. The Documentation Claims vs Reality

The README claims you can run 'bun run --cwd packages/desktop dev' for 'web-only development mode.' This is a lie. As documented in issue #10160, this immediately crashes with Tauri API errors because the code calls Tauri APIs unconditionally. The documentation literally documents non-functional features.

3. Missing Critical Information

Here's what the desktop documentation completely omits:

  • RUST_TARGET environment variable requirements (Issue #8488)
  • Platform-specific Tauri dependencies
  • How to set up a development environment from scratch
  • Troubleshooting common errors
  • How to run tests for the desktop app
  • Architecture overview of desktop vs web vs TUI
  • Any mention of the desktop app in the main documentation

4. The Documentation Hierarchy is Broken

  • Main README: Mentions desktop app exists, zero setup info
  • Main docs site: No desktop-specific documentation section
  • Contributing guide: Silent on desktop development
  • Packages/desktop/README: The aforementioned 4-line disaster

The Impact

This documentation failure has real consequences:

  • Issue #6780: 'missing documentation for how to run desktop from source' - CLOSED but clearly not fixed
  • Issue #8488: 'Improve packages/desktop README with environment setup instructions' - Still open
  • Issue #10160: Desktop dev mode crashes because documentation lied about web-only development
  • Issue #8050: Linux Desktop binaries not in release - probably because nobody can build them
  • Issue #11032: Users can't add custom providers in desktop app - no documentation on how desktop config works

The Irony

The main OpenCode documentation proudly states: 'OpenCode is an open source AI coding agent. It is available as a terminal-based interface, desktop app, or IDE extension.'

Translation: 'We mention our desktop app exists, but we'll be damned if we tell you how to use it, build it, or contribute to it.'

What Needs to Happen (Yesterday)

  1. Fire whoever wrote the current desktop README (or at least make them use their own documentation)
  2. Create actual desktop documentation that includes:
    • Complete environment setup for each platform
    • Troubleshooting guide for common errors
    • Architecture overview
    • Development workflow
    • Testing procedures
  3. Add desktop section to main documentation
  4. Document the relationship between desktop/web/TUI modes
  5. Create a desktop-specific contributing guide

Bottom Line

This isn't just poor documentation - this is documentation malpractice. For a project that claims to be an 'AI coding agent,' the complete inability to document your own desktop application is embarrassing and unprofessional.

Fix this immediately or stop claiming you have a desktop application. The current state is worse than having no desktop app at all - it's having one that nobody can use, build, or contribute to.

Priority: Critical
Labels: docs, web, desktop, documentation-failure, good-first-issue (ironic)

Originally created by @dl-alexandre on GitHub (Feb 8, 2026). Originally assigned to: @jayair on GitHub. ## The Problem Let me be crystal clear about the absolutely abysmal state of OpenCode's desktop application documentation. This isn't just 'missing documentation' - this is a **comprehensive documentation failure** that borders on intentional sabotage of your own project. ## The Evidence ### 1. The Desktop README is a Joke The packages/desktop/README.md contains exactly **4 lines** of actual useful information: - bun install - bun run --cwd packages/desktop tauri dev - bun run --cwd packages/desktop dev - bun run --cwd packages/desktop tauri build That's it. No environment setup. No troubleshooting. No prerequisites beyond a vague 'see Tauri prerequisites' link. This is documentation for **noobs by noobs**. ### 2. The Documentation Claims vs Reality The README claims you can run 'bun run --cwd packages/desktop dev' for 'web-only development mode.' **This is a lie.** As documented in issue #10160, this immediately crashes with Tauri API errors because the code calls Tauri APIs unconditionally. The documentation literally documents **non-functional features**. ### 3. Missing Critical Information Here's what the desktop documentation **completely omits**: - **RUST_TARGET environment variable requirements** (Issue #8488) - **Platform-specific Tauri dependencies** - **How to set up a development environment from scratch** - **Troubleshooting common errors** - **How to run tests for the desktop app** - **Architecture overview of desktop vs web vs TUI** - **Any mention of the desktop app in the main documentation** ### 4. The Documentation Hierarchy is Broken - Main README: Mentions desktop app exists, zero setup info - Main docs site: No desktop-specific documentation section - Contributing guide: Silent on desktop development - Packages/desktop/README: The aforementioned 4-line disaster ## The Impact This documentation failure has **real consequences**: - **Issue #6780**: 'missing documentation for how to run desktop from source' - CLOSED but clearly not fixed - **Issue #8488**: 'Improve packages/desktop README with environment setup instructions' - Still open - **Issue #10160**: Desktop dev mode crashes because documentation lied about web-only development - **Issue #8050**: Linux Desktop binaries not in release - probably because nobody can build them - **Issue #11032**: Users can't add custom providers in desktop app - no documentation on how desktop config works ## The Irony The main OpenCode documentation proudly states: 'OpenCode is an open source AI coding agent. It is available as a terminal-based interface, desktop app, or IDE extension.' **Translation:** 'We mention our desktop app exists, but we'll be damned if we tell you how to use it, build it, or contribute to it.' ## What Needs to Happen (Yesterday) 1. **Fire whoever wrote the current desktop README** (or at least make them use their own documentation) 2. **Create actual desktop documentation** that includes: - Complete environment setup for each platform - Troubleshooting guide for common errors - Architecture overview - Development workflow - Testing procedures 3. **Add desktop section to main documentation** 4. **Document the relationship between desktop/web/TUI modes** 5. **Create a desktop-specific contributing guide** ## Bottom Line This isn't just poor documentation - this is **documentation malpractice**. For a project that claims to be an 'AI coding agent,' the complete inability to document your own desktop application is **embarrassing** and **unprofessional**. **Fix this immediately** or stop claiming you have a desktop application. The current state is worse than having no desktop app at all - it's having one that nobody can use, build, or contribute to. --- Priority: Critical Labels: docs, web, desktop, documentation-failure, good-first-issue (ironic)
yindo added the webdocs labels 2026-02-16 18:11:00 -05:00
yindo commented 2026-02-16 18:11:01 -05:00
Author
Owner
Copy Link
Copy Source

@github-actions[bot] commented on GitHub (Feb 8, 2026):

This issue might be a duplicate of existing issues. Please check:

  • #8488: Improve packages/desktop README with environment setup instructions - addresses RUST_TARGET and environment variable documentation
  • #6780: missing documentation for how to run desktop from source - directly covers the desktop development documentation gap
  • #10160: packages/desktop dev mode crashes in browser - Tauri APIs called unconditionally - addresses the specific issue about the non-functional 'web-only development mode'
  • #8997: Add docs for how to build from source and contribute to README.md - requests documentation for building and contributing

These issues cover many of the specific concerns raised in this issue. Feel free to ignore if there are additional documentation gaps or structural improvements beyond what those issues address.

@github-actions[bot] commented on GitHub (Feb 8, 2026): This issue might be a duplicate of existing issues. Please check: - #8488: Improve packages/desktop README with environment setup instructions - addresses RUST_TARGET and environment variable documentation - #6780: missing documentation for how to run desktop from source - directly covers the desktop development documentation gap - #10160: packages/desktop dev mode crashes in browser - Tauri APIs called unconditionally - addresses the specific issue about the non-functional 'web-only development mode' - #8997: Add docs for how to build from source and contribute to README.md - requests documentation for building and contributing These issues cover many of the specific concerns raised in this issue. Feel free to ignore if there are additional documentation gaps or structural improvements beyond what those issues address.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
acp
bad
bug
discussion
docs
documentation
enhancement
extension
good first issue
growth
help-wanted
mcp
model-problem
needs:compliance
nix
opentui
perf
pull-request
Mirrored from GitHub Pull Request
 tui
web
windows
zen
No Label docs web
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: anomalyco/opencode#8849
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?