Skip to content

README: add status preview screenshot - #121

Merged
yourconscience merged 2 commits into
mainfrom
readme-status-preview
Jul 18, 2026
Merged

README: add status preview screenshot#121
yourconscience merged 2 commits into
mainfrom
readme-status-preview

Conversation

@yourconscience

@yourconscience yourconscience commented Jul 18, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add docs/status-preview.png showing dotagents status output with color-coded harness sections
  • Embed it in README between the intro and "Why" section
  • Include source HTML for re-rendering if content changes

Improves first-impression conversion — text-only READMEs perform worse for developer tools.

Summary by Sourcery

Add a visual status preview of dotagents status to the README using a generated terminal-style screenshot.

Documentation:

  • Embed a centered status preview image in the README to illustrate dotagents status output.
  • Add an HTML source file for regenerating the status preview screenshot used in documentation.

@sourcery-ai

sourcery-ai Bot commented Jul 18, 2026

Copy link
Copy Markdown

Reviewer's Guide

Adds 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 screenshot

flowchart 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
Loading

File-Level Changes

Change Details Files
Embed a status preview screenshot into the README near the top of the document.
  • Insert a centered HTML tag referencing docs/status-preview.png directly under the introductory links section.
  • Constrain the screenshot width to 720px and provide an alt attribute for accessibility.
README.md
Add self-contained HTML used to render the status preview screenshot.
  • Create a standalone HTML document that renders a faux terminal window themed for GitHub-dark styling.
  • Define CSS classes for terminal chrome, colors, and semantic tokens (skills, MCPs, hooks, agents, statuses).
  • Inline the sample dotagents status output with semantic spans so colors map to harness sections and statuses.
  • Structure the page so it centers the terminal and can be used to regenerate docs/status-preview.png via browser screenshots or automation.
docs/status-preview.html

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread README.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread docs/status-preview.html
Comment on lines +88 to +90
<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>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge 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 👍 / 👎.

@yourconscience
yourconscience merged commit 544c395 into main Jul 18, 2026
4 checks passed
@yourconscience
yourconscience deleted the readme-status-preview branch July 18, 2026 09:38
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