README: add status preview screenshot - #121
Conversation
Reviewer's GuideAdds a centered status preview screenshot to the README and checks in the HTML source used to generate the image so the preview can be easily re-rendered when the status output changes. Flow diagram for regenerating the status preview screenshotflowchart LR
dev[Developer updates docs/status-preview.html]
browser[Open HTML in browser]
capture[Capture screenshot as docs/status-preview.png]
readme[README.md embeds docs/status-preview.png]
dev --> browser --> capture --> readme
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="README.md" line_range="9" />
<code_context>
**[Overview & comparison →](https://yourconscience.github.io/dotagents/)** · [Releases](https://github.com/yourconscience/dotagents/releases)
+<p align="center"><img src="docs/status-preview.png" alt="dotagents status" width="720"></p>
+
## Why
</code_context>
<issue_to_address>
**suggestion:** Consider making the image alt text more descriptive for accessibility.
"dotagents status" is quite minimal as alt text. Please use something more descriptive (e.g., "Screenshot of the dotagents status view") to better support screen reader users.
```suggestion
<p align="center"><img src="docs/status-preview.png" alt="Screenshot of the dotagents status view in the web UI" width="720"></p>
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5d8801f9ce
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| <span class="label">managed</span> <span class="dim">(16):</span> <span class="skill">dotagents, grill-me, grilling, gws, humanizer, | ||
| jobs, pr-triage, remote-access, repo-eval, spawn, | ||
| spec, tech-search, tg, tmux, x-cli, x-sim</span> |
There was a problem hiding this comment.
Replace private status output with starter inventory
In the public checkout, AGENTS.md says this repo “must not contain a maintainer's personal skills, hooks, MCP servers” and lists only skills/dotagents/ and skills/grilling/ as starter skills. This preview embeds a private dotagents status inventory with non-starter skills like gws, humanizer, pr-triage, etc. (with adjacent private MCP/hooks/memory details), and README now renders the matching PNG, so the public distribution leaks/misrepresents maintainer-specific configuration instead of generic starter content.
Useful? React with 👍 / 👎.
Summary
docs/status-preview.pngshowingdotagents statusoutput with color-coded harness sectionsImproves first-impression conversion — text-only READMEs perform worse for developer tools.
Summary by Sourcery
Add a visual status preview of
dotagents statusto the README using a generated terminal-style screenshot.Documentation:
dotagents statusoutput.