docs: rewrite README around background, features, and the omp assistant - #9
Merged
Conversation
- 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)
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
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.
What
Restructure the README so it reads like something a person wrote for people, in the order a newcomer actually needs:
omp configCLI) plus omp-web's own session management, instead of building and maintaining a settings UI.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