taodeng/ocm
1
0
Fork 0
mirror of https://github.com/dtzp555-max/ocm.git synced 2026-07-21 21:15:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
fix/orphan-agents-default-to-main
ocm/docs/SCREENSHOT_REFRESH_BRIEF.md
T
dtzp555-maxGitHubtaodeng
 743b8acea1 docs: improve README positioning and refresh hero screenshots (#5) 
* docs: rewrite README around first-run value and support positioning

* docs: add screenshot refresh brief and trim README repetition

* docs: refresh README hero screenshots

---------

Co-authored-by: Tao <dtzp555@gmail.com>
2026-03-07 20:17:49 +10:00

2.2 KiB
Raw Permalink Blame History

OCM Screenshot Refresh Brief

Goal: refresh only the highest-value README screenshots first, not every screenshot.

Redaction rules

Always hide or blur:

  • Telegram / Discord IDs
  • bindings / peer IDs / thread IDs
  • local filesystem paths containing Tao's name
  • account labels if they expose personal identifiers
  • anything that looks like a secret/token

Priority 1 screenshots

1) Dashboard hero

Purpose:

  • show OCM as a real control panel
  • support the README first-run / health story

Wanted state:

  • Dashboard page open
  • gateway looks healthy if possible
  • cards readable
  • top bar clean
  • no obvious warning/noise unless it helps credibility

Frame guidance:

  • browser window wide enough to show full dashboard naturally
  • keep top navigation visible
  • avoid cropping too tightly

2) Agents page

Purpose:

  • show the core product value: visible agent topology / structure

Wanted state:

  • main agent + several sub-agents visible
  • structure easy to understand at a glance
  • avoid visual clutter where possible
  • keep model selectors/buttons visible, but not the focus

Frame guidance:

  • enough width to show the tree clearly
  • IDs and personal paths redacted

3) CLI / Terminal page

Purpose:

  • show that OCM is not only a viewer; it can operate OpenClaw too

Wanted state:

  • built-in terminal open
  • a real command visible (recommended: openclaw status or openclaw doctor)
  • real output visible
  • do not use tutorial arrows / annotation bubbles

Frame guidance:

  • include command input and some output
  • avoid empty terminal state
  • redact paths / personal names

Priority 2 screenshots

  • Actions menu
  • Backup / rollback
  • Channels
  • Models
  • Auth
  • Cron
  • Stats

Selected refresh set (2026-03-07)

  • Dashboard: docs/redacted-screenshots-refresh/dashboard-2026-03-07.jpg
  • Agents: docs/redacted-screenshots-refresh/agents-2026-03-07.jpg
  • CLI: docs/redacted-screenshots-refresh/cli-2026-03-07.jpg
  • Keep using existing docs/redacted-screenshots/actions.jpg for now

Notes

  • Existing actions.jpg is already strong and can stay for now.
  • The new Dashboard and Agents captures are preferred for README hero/overview use.
  • The new CLI capture is preferred because it shows a real command and real output.
Reference in New Issue View Git Blame Copy Permalink