Skip to content

docs: focus docs on gh-aw workflows; move Claude to legacy#280

Merged
strawgate merged 4 commits intomainfrom
main-e80841f17cd792f2
Feb 21, 2026
Merged

docs: focus docs on gh-aw workflows; move Claude to legacy#280
strawgate merged 4 commits intomainfrom
main-e80841f17cd792f2

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Feb 21, 2026

Summary

  • prioritize GitHub Agent Workflows in top-level docs messaging
  • move Claude docs framing to an explicit legacy section
  • adjust docs navigation so Claude docs are nested under Legacy

Files changed

  • README.md
  • docs/index.md
  • docs/workflows/claude-workflows.md
  • mkdocs.yml

Validation


What is this? | From workflow: Issue Assistant

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #276

Summary by CodeRabbit

  • Documentation
    • Establishes GitHub Agent Workflows as the recommended approach with safe-output guardrails.
    • Reframes Claude Composite Actions as a legacy option and moves it into a dedicated "Legacy" section.
    • Simplifies workflow guidance and reorganizes content (condensed tables, updated headings and explanatory text) for clearer installation and maintenance guidance.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@coderabbitai
Copy link

coderabbitai bot commented Feb 21, 2026

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

Reorganized documentation to recommend GitHub Agent Workflows as the primary approach and relabeled/moved Claude Composite Actions into a dedicated "Legacy" section across README, docs, and mkdocs navigation.

Changes

Cohort / File(s) Summary
Top-level docs
README.md, docs/index.md
Updated headings and overview: renamed "Choose an approach" to "Recommended approach", made GitHub Agent Workflows the recommended single-column entry, moved Claude Composite Actions link into a new Legacy subsection and relabeled it "Legacy Claude Composite Actions".
Workflows doc
docs/workflows/claude-workflows.md
Renamed title to "Legacy: Claude Composite Actions", added a note directing future deployments to GitHub Agent Workflows, reordered content to present legacy information first, retained directory rename/backcompat note.
Site navigation
mkdocs.yml
Moved the Claude Composite Actions nav entry under a nested "Legacy" section within Workflows, preserving target document but changing hierarchy.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Poem

🐰 The docs took a hop and found their way,
New workflows lead the bright new day,
Claude's old path rests in a quiet glade,
Labeled "Legacy" where memories fade,
Hop on forward — the guide is made! 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs: focus docs on gh-aw workflows; move Claude to legacy' accurately and clearly reflects the main changes—reorganizing documentation to prioritize GitHub Agent Workflows and moving Claude to a legacy section.
Linked Issues check ✅ Passed The PR successfully addresses all coding-related objectives from issue #276: prioritizing gh-aw workflows in top-level documentation, moving Claude to an explicit Legacy section, and updating navigation structure.
Out of Scope Changes check ✅ Passed All changes in the PR are directly aligned with the linked issue objectives—documentation reorganization, section restructuring, and navigation updates for gh-aw prioritization and Claude legacy designation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch main-e80841f17cd792f2

Comment @coderabbitai help to get the list of available commands and usage tips.

@strawgate strawgate marked this pull request as ready for review February 21, 2026 02:36
@strawgate
Copy link
Collaborator

/ai the index should only mention the gh-aw workflows in the starting section, in the footer is fine, it's all about our agent workflows!

@elastic elastic deleted a comment from github-actions bot Feb 21, 2026
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Contributor Author

Implemented your feedback and pushed a follow-up commit to this PR.

✅ Updated docs/index.md so the starting Recommended approach section only mentions GitHub Agent Workflows.
✅ Kept Claude references in the Legacy section.
✅ Ran make lint successfully after the change.


What is this? | From workflow: PR Assistant

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #280

@strawgate strawgate merged commit 1b18f9d into main Feb 21, 2026
@strawgate strawgate deleted the main-e80841f17cd792f2 branch February 21, 2026 03:08
Copilot AI added a commit that referenced this pull request Feb 21, 2026
Brings all updates from main into this branch:
- Standardized workflow names/descriptions (#277)
- Docs restructure with Legacy section (#280)
- duplicate-issue-detector detect-related-issues input (#283)
- Improved Copilot agent thoroughness checks (#289)
- Label-based opt-out for update-pr-body trigger (#286)

Merges mkdocs.yml to keep both the Legacy section from main
and the new Text Beautifier entry from this branch.

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
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.

Focus the docs on gh-aw workflows and put in a legacy section for Claude

1 participant