Skip to content

docs: fix three README accuracy gaps#14

Merged
verkyyi merged 1 commit intomainfrom
docs/fix-readme-accuracy-gaps-5b2f4edce0da1bb8
Apr 19, 2026
Merged

docs: fix three README accuracy gaps#14
verkyyi merged 1 commit intomainfrom
docs/fix-readme-accuracy-gaps-5b2f4edce0da1bb8

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Three small inaccuracies found by cross-referencing README.md against the actual workflow .md source files:

1. repo-assist missing 👀 reaction trigger

repo-assist.md frontmatter declares four triggers: schedule: every 12h, workflow_dispatch, slash_command: repo-assist, and reaction: "eyes". The README table only listed the first two meaningful ones (Every 12 h + /repo-assist), silently dropping the 👀 reaction path that lets maintainers trigger an on-demand run by reacting to any issue or PR.

2. catalog.md layout comment was stale

The repository layout section described catalog.md as (stub until scope-lock). The catalog was populated with 7 entries in PR #7, and the Publishing checklist in the same file already acknowledges this (~~Fill in catalog.md~~ — catalog populated with 7 entries). The layout comment was never updated to match.

3. Missing GitHub Discussions prerequisite

daily-plan.md uses safe-outputs: create-discussion: category: "announcements" and weekly-research.md uses category: "ideas". A fork maintainer who enables these workflows without GitHub Discussions turned on will see them fail silently. The Prerequisites section now calls this out explicitly.

All three changes are README.md only — no skill logic, no lock files, no catalog entries touched.

Generated by Update Docs ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/update-docs.md@96b9d4c39aa22359c0b38265927eadb31dcf4e2a

- repo-assist trigger was missing the 👀 (eyes) reaction that the
  workflow frontmatter declares alongside /repo-assist and the schedule
- catalog.md repository-layout comment still read "(stub until
  scope-lock)" after the catalog was populated with 7 entries in PR #7
- Prerequisites section for fork maintainers didn't mention GitHub
  Discussions must be enabled; daily-plan (announcements category) and
  weekly-research (ideas category) both require it

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Apr 19, 2026
@verkyyi verkyyi marked this pull request as ready for review April 19, 2026 22:37
@verkyyi verkyyi merged commit f40411d into main Apr 19, 2026
20 checks passed
@verkyyi verkyyi deleted the docs/fix-readme-accuracy-gaps-5b2f4edce0da1bb8 branch April 19, 2026 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant