Skip to content

docs: sync README and CONTRIBUTING with catalog population#8

Merged
verkyyi merged 1 commit intomainfrom
docs/sync-catalog-population-572205cd5997189f
Apr 19, 2026
Merged

docs: sync README and CONTRIBUTING with catalog population#8
verkyyi merged 1 commit intomainfrom
docs/sync-catalog-population-572205cd5997189f

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented Apr 19, 2026

What changed

PR #7 populated skills/discover/catalog.md from an empty stub to 7 curated workflow entries, but left two documentation files with stale text describing the catalog as empty.

README.md

  • Added an "Available catalog workflows" table under the /sidekick:discover section listing all 7 entries with purpose and setup friction — mirrors the pattern of the installed-workflows table above it.
  • Updated Publishing checklist: struck through step 1 (catalog fill-in) and noted it is done; removed the trailing blockquote that said the catalog was intentionally empty.

CONTRIBUTING.md

  • Updated "Adding catalog entries" subsection: removed "stub pending curation" language; now accurately states the catalog has 7 entries.
  • Fixed catalog entry template: heading level was ### but the actual catalog uses ## — corrected to match.
  • Removed the "5–8 entries" target from the quality guidance (catalog already in that range; a fixed target is no longer meaningful).

Testing

No code changed — docs-only. Verify by reading the rendered README on the branch and confirming:

  • The catalog workflow table renders under /sidekick:discover
  • Publishing section no longer references an empty catalog
  • CONTRIBUTING template block uses ## heading

Generated by Update Docs ·

To install this agentic workflow, run

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

The discover catalog moved from empty stub to 7 curated entries.
Update README and CONTRIBUTING to reflect current state:

- README: add catalog workflow table under /sidekick:discover; mark
  Publishing step 1 done; remove stale "catalog intentionally empty" note
- CONTRIBUTING: drop "stub pending curation" language; fix catalog entry
  template heading level (### → ##) to match actual catalog format

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 18:07
@verkyyi verkyyi merged commit 8ce1cf6 into main Apr 19, 2026
60 checks passed
@verkyyi verkyyi deleted the docs/sync-catalog-population-572205cd5997189f branch April 19, 2026 18:12
github-actions Bot added a commit that referenced this pull request Apr 19, 2026
- README.md repository layout: catalog.md comment still said
  "stub until scope-lock"; updated to "(7 entries)" to match reality
  after PR #7 populated the catalog.

- CONTRIBUTING.md Workflow files section said "six dogfooded
  workflows"; the repo has always had seven (repo-assist, daily-plan,
  update-docs, q, markdown-linter, pr-nitpick-reviewer, weekly-research)
  — corrected to "seven", consistent with README line 14.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
github-actions Bot added a commit that referenced this pull request Apr 19, 2026
PR #7 replaced the TBD placeholders in plugin.json (author.name,
homepage, repository) with real values. PR #8 struck through step 1
of the publishing checklist but missed step 2. Mark it done.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
verkyyi pushed a commit that referenced this pull request Apr 19, 2026
PR #7 replaced the TBD placeholders in plugin.json (author.name,
homepage, repository) with real values. PR #8 struck through step 1
of the publishing checklist but missed step 2. Mark it done.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
github-actions Bot added a commit that referenced this pull request Apr 19, 2026
Two workflow files and the .vscode/ directory existed but were absent
from all documentation — a contributor scanning .github/workflows/ saw
9 files while the README only accounted for 7.

README.md:
- Add agentics-maintenance.yml and copilot-setup-steps.yml to the
  repository layout code block with inline comments
- Add .vscode/ directory (mcp.json, settings.json) to the layout
- Add "Infrastructure workflows" section explaining both files:
  agentics-maintenance.yml is auto-generated (do not edit by hand);
  copilot-setup-steps.yml pre-installs gh-aw for Copilot Agent sessions

CONTRIBUTING.md:
- Add "VS Code + GitHub Copilot" subsection under Development setup
  describing what .vscode/mcp.json and .vscode/settings.json provide
  and that they activate automatically (no manual steps)

Supersedes PR #6, which carried the same changes but accumulated merge
conflicts as PRs #8#15 landed on main.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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