Skip to content

docs: document infrastructure workflows and VS Code tooling#18

Closed
github-actions[bot] wants to merge 1 commit intomainfrom
docs/document-infra-workflows-and-vscode-tooling-9d7304c4830a1ed1
Closed

docs: document infrastructure workflows and VS Code tooling#18
github-actions[bot] wants to merge 1 commit intomainfrom
docs/document-infra-workflows-and-vscode-tooling-9d7304c4830a1ed1

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Two workflow files (agentics-maintenance.yml, copilot-setup-steps.yml) and the .vscode/ directory have been present in the repository since early commits but were absent from all documentation. A contributor scanning .github/workflows/ sees 9 files while the README only accounts for 7 — a confusing gap.

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

Changes

README.md

  • Added agentics-maintenance.yml and copilot-setup-steps.yml to the repository layout code block with inline comments
  • Added .vscode/ directory (mcp.json, settings.json) to the repository layout
  • Added a new Infrastructure workflows section with a table explaining both files:
    • agentics-maintenance.yml is auto-generated by gh aw compile and must not be edited by hand
    • copilot-setup-steps.yml pre-installs the gh aw extension for GitHub Copilot Agent sessions

CONTRIBUTING.md

  • Added a VS Code + GitHub Copilot subsection under Development setup, explaining what .vscode/mcp.json and .vscode/settings.json provide and that they activate automatically (no manual steps required)

Why

Documentation gaps are treated like failing tests. These files serve distinct purposes that affect the contributor experience — particularly the "do not edit by hand" constraint on agentics-maintenance.yml, which silently reverts to a generated form on every gh aw compile run.

Testing

  • Repository layout renders with all 9 workflow files visible
  • Infrastructure workflows table renders correctly
  • VS Code + GitHub Copilot subsection appears under Development setup in CONTRIBUTING
  • Diff is purely additive — no existing content altered

Generated by Update Docs ·

Generated by Update Docs ·

To install this agentic workflow, run

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

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>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Apr 19, 2026
@verkyyi
Copy link
Copy Markdown
Owner

verkyyi commented Apr 20, 2026

Closing as stale. Since this PR opened (2026-04-19), README and CONTRIBUTING have been rewritten twice — once for the plugin rename (ede7a80) and once for the catalog drop (1279a99). Any additions this PR proposed are against a doc structure that no longer exists. Also duplicated by #19 with the same title. If this content is still wanted, please re-open a fresh PR against the current docs.

@verkyyi verkyyi closed this Apr 20, 2026
@verkyyi verkyyi deleted the docs/document-infra-workflows-and-vscode-tooling-9d7304c4830a1ed1 branch April 20, 2026 03:39
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