Make the Skills README understandable at a glance #6

Closed
opened 2026-10-09 08:15:01 -04:00 by anodyine · 3 comments
Owner

Problem

A visitor can read the package list but cannot quickly see how a named skill set is assigned to a RelayView role in the current UI.

Scope

Improve the README's first-time-reader path with:

  • One screenshot of the current Settings → Skills UI showing a named set in its compatible role selector.
  • A copyable YAML excerpt defining that same named set, including its role, step, invocation mode, and ordered members.
  • A short caption connecting the configuration to what the UI displays. Distinguish an available set from an active selection.
  • Alt text and a link to the existing NOTICE for adapted skills.

Use a real current UI capture. Crop or redact personal information and private configuration details. Review the exact image and copy with the owner before publishing, since the screenshot reveals part of RelayView before launch.

Add other README clarity findings discovered during this review to this issue if they help a new visitor understand the skill release. Keep unrelated release-safety findings in the audit issue.

Acceptance Criteria

  • A visitor can understand the named-set-to-role relationship from the screenshot, YAML, and caption without reading the full configuration guide.
  • The YAML is selectable text and accurately reflects a supported current configuration; it contains no private paths or credentials.
  • The screenshot matches current UI behavior, has useful alt text, and renders clearly on the source host and public mirror.
  • The README distinguishes original packages from adapted guidance and preserves third-party attribution.
  • The owner has reviewed the exact material before it becomes a prominent public link.
  • Documentation disposition is recorded.

Ablation decision

not_required: README presentation and documentation only.

## Problem A visitor can read the package list but cannot quickly see how a named skill set is assigned to a RelayView role in the current UI. ## Scope Improve the README's first-time-reader path with: - One screenshot of the current Settings → Skills UI showing a named set in its compatible role selector. - A copyable YAML excerpt defining that same named set, including its role, step, invocation mode, and ordered members. - A short caption connecting the configuration to what the UI displays. Distinguish an available set from an active selection. - Alt text and a link to the existing NOTICE for adapted skills. Use a real current UI capture. Crop or redact personal information and private configuration details. Review the exact image and copy with the owner before publishing, since the screenshot reveals part of RelayView before launch. Add other README clarity findings discovered during this review to this issue if they help a new visitor understand the skill release. Keep unrelated release-safety findings in the audit issue. ## Acceptance Criteria - A visitor can understand the named-set-to-role relationship from the screenshot, YAML, and caption without reading the full configuration guide. - The YAML is selectable text and accurately reflects a supported current configuration; it contains no private paths or credentials. - The screenshot matches current UI behavior, has useful alt text, and renders clearly on the source host and public mirror. - The README distinguishes original packages from adapted guidance and preserves third-party attribution. - The owner has reviewed the exact material before it becomes a prominent public link. - Documentation disposition is recorded. ## Ablation decision `not_required`: README presentation and documentation only.
anodyine added the status/ready-for-agenttype/docsarea/docs labels 2026-10-09 08:15:01 -04:00
anodyine added a new dependency 2026-10-09 08:15:31 -04:00
anodyine added a new dependency 2026-10-09 08:15:36 -04:00
anodyine added a new dependency 2026-10-09 08:15:41 -04:00
Author
Owner

README review finding from the starter-planner smoke check: the current "Fork the starter" section says to import a user fork and assign it to the matching role, but omits a required step. The current Settings UI offers named-set selectors for each role; importing a package alone does not put it in a selectable set. For this README improvement, add the tested path: add the imported ID to a compatible named set in owner configuration, reload the owner, select that set in Settings, and verify a new Planner session captures the fork. Distinguish package validation from this end-to-end admission/assignment check.

Evidence so far: all 12 public package tests pass; the starter checks and packs; a renamed and edited scratch fork checks and packs; four focused RelayView package/assignment tests pass. A live Planner smoke has not yet been run.

README review finding from the starter-planner smoke check: the current "Fork the starter" section says to import a user fork and assign it to the matching role, but omits a required step. The current Settings UI offers named-set selectors for each role; importing a package alone does not put it in a selectable set. For this README improvement, add the tested path: add the imported ID to a compatible named set in owner configuration, reload the owner, select that set in Settings, and verify a new Planner session captures the fork. Distinguish package validation from this end-to-end admission/assignment check. Evidence so far: all 12 public package tests pass; the starter checks and packs; a renamed and edited scratch fork checks and packs; four focused RelayView package/assignment tests pass. A live Planner smoke has not yet been run.
anodyine added status/in-progress and removed status/ready-for-agent labels 2026-10-09 09:07:33 -04:00
anodyine added reference ISSUE-6 2026-10-09 09:07:35 -04:00
Author
Owner

Implemented in PR #7: #7

The branch README contains the owner-selected Reviewer screenshot, copyable reviewer-inspection YAML, saved/effective explanation, alt text, and a nearby NOTICE link. The source-host rendering and 12 provider-free tests were checked at commit b2ad71ea1de3af6fca86a66ba5ef81234b1411f6.

Documentation disposition: updated — the README now explains the current named-set-to-role relationship. Ablation decision: not_required — documentation only. The exact README copy and visual are ready for owner review in the PR; the GitHub mirror render check remains in #5.

Implemented in PR #7: https://tea.kyle-merritt.com/anodyine/relayview-skills/pulls/7 The branch README contains the owner-selected Reviewer screenshot, copyable `reviewer-inspection` YAML, saved/effective explanation, alt text, and a nearby NOTICE link. The source-host rendering and 12 provider-free tests were checked at commit `b2ad71ea1de3af6fca86a66ba5ef81234b1411f6`. Documentation disposition: `updated` — the README now explains the current named-set-to-role relationship. Ablation decision: `not_required` — documentation only. The exact README copy and visual are ready for owner review in the PR; the GitHub mirror render check remains in #5.
anodyine added status/review and removed status/in-progress labels 2026-10-09 09:10:02 -04:00
Author
Owner

Merged #7 after review and required verification; issue cleanup is complete.

Required remote CI at merge: not configured.

Advisory remote CI at merge (non-blocking): success (2 reported checks). Check instruction packages / check (push)=success, Check instruction packages / check (pull_request)=success.

Merged https://tea.kyle-merritt.com/anodyine/relayview-skills/pulls/7 after review and required verification; issue cleanup is complete. Required remote CI at merge: not configured. Advisory remote CI at merge (non-blocking): success (2 reported checks). `Check instruction packages / check (push)`=success, `Check instruction packages / check (pull_request)`=success. <!-- gitea-issues-cleanup issue=6 pull=7 -->
anodyine added status/done and removed status/review labels 2026-10-09 09:12:46 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Reference: anodyine/relayview-skills#6