docs: explain project directories and sessions in the TUI guide

Open Beginner friendly
#40,938 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Domain
cli, documentation

Research direction

The issue does not name a file; start with the TUI guide section around Initialize and Usage. Add a short section explaining projects, directories, workspaces, and sessions, including /new, /sessions, and opencode /path/to/project, then confirm the guide gives newcomers a clear mental model before the usage details.

Written by the indexing model from the issue text.

Description

Feature hasn't been suggested before.
  • I have verified this feature I'm about to request hasn't been suggested before.
Describe the enhancement you want to request

A new OpenCode user, especially one coming from a traditional desktop app or IDE, may not immediately understand how OpenCode organizes projects, workspaces, directories, and sessions.

I suggest adding a short section after Initialize and before Usage that explains this mental model and the common workflows around it, such as:

  • what project/directory OpenCode is currently working in;
  • what a workspace represents and how it relates to the project;
  • how sessions relate to the current workspace/project;
  • starting a separate task with /new;
  • returning to an existing session with /sessions;
  • starting OpenCode for another project with opencode /path/to/project.

This would give newcomers a good conceptual model before the guide moves into individual ways of using OpenCode.

Dominant language
TypeScript
Stars
209k
Forks
27.5k
Avg merge
7h 20m
Merged PRs (30d)
358

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from anomalyco/opencode

All issues in anomalyco/opencode

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.