Skip to content

docs: rewrite README around background, features, and the omp assistant - #9

Merged
danielglh merged 1 commit into
mainfrom
docs/readme-overhaul
Aug 28, 2026
Merged

docs: rewrite README around background, features, and the omp assistant#9
danielglh merged 1 commit into
mainfrom
docs/readme-overhaul

Conversation

@danielglh

Copy link
Copy Markdown
Owner

What

Restructure the README so it reads like something a person wrote for people, in the order a newcomer actually needs:

  1. Why this exists — the personal need up front: drive omp on a remote dev server from a browser, working well on both desktop and phone.
  2. Core features — sessions/workspace rail, the chat UI (streaming, thinking blocks, tool cards, approvals), file browsing/previews, and first-class mobile drawers, each with a screenshot.
  3. omp assistant — its own section making the design point explicit: one agent entry covers all omp configuration (via the real omp config CLI) plus omp-web's own session management, instead of building and maintaining a settings UI.
  4. Install & use and Local development — trimmed to what's actionable; roadmap removed from the README.

Also adds a simplified-Chinese version at docs/README.zh-CN.md, cross-linked from both files.

Screenshots

All under docs/screenshots/ (7 PNGs, ~1.3 MB total). They were captured from a live instance running the bundled scripted agent with placeholder demo projects (/home/demo/website, /home/demo/api-server) in a throwaway container — nothing personal or real-project-related is visible in any of them.

Notes

  • Pure markdown everywhere (the phone pair uses a table for side-by-side), so no sanitizer shows 'image blocked' placeholders.
  • Roadmap items aren't lost — just no longer in the README; happy to move them to an issue if wanted.

- Lead with the personal need: drive omp on a remote dev server from a
  browser, on desktop and phone
- Show core features with screenshots (sessions, chat + approvals, file
  previews, mobile drawers)
- Give the omp assistant its own section: one agent entry covering all
  omp configuration instead of a settings UI surface
- Trim install/usage and local development to what matters; drop the
  roadmap from the README
- Add docs/README.zh-CN.md (simplified Chinese) and cross-link both
- Add docs/screenshots/ captured against placeholder demo projects
  (/home/demo/website, /home/demo/api-server)
@danielglh
danielglh merged commit 5cda054 into main Aug 28, 2026
1 check passed
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.

1 participant