Skip to content

docs: move guides into docs/ and add maintainers guide#25

Merged
scottschreckengaust merged 6 commits intomainfrom
docs/migrate-guides-to-docs-dir
Feb 12, 2026
Merged

docs: move guides into docs/ and add maintainers guide#25
scottschreckengaust merged 6 commits intomainfrom
docs/migrate-guides-to-docs-dir

Conversation

@scottschreckengaust
Copy link
Member

@scottschreckengaust scottschreckengaust commented Feb 11, 2026

Summary

  • Move DEVELOPMENT_GUIDE.md, DESIGN_GUIDELINES.md, and TROUBLESHOOTING.md from repo root into docs/ directory
  • Create docs/MAINTAINERS_GUIDE.md with PR review workflows, role definitions, merge rules, CI/CD overview, labels, and stale automation
  • Update all references in README.md, CONTRIBUTING.md, AGENTS.md, CODEOWNERS, and DESIGN_GUIDELINES.md

Test plan

  • mise run build passes (lint, format, security, cross-refs, manifests)
  • Verify all markdown links resolve correctly on GitHub
  • Verify filtered PR view links in maintainers guide work

🤖 Generated with Claude Code

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.

@scottschreckengaust scottschreckengaust requested a review from a team February 11, 2026 23:09
@scottschreckengaust scottschreckengaust requested a review from a team as a code owner February 11, 2026 23:09
krokoko
krokoko previously approved these changes Feb 11, 2026
@scottschreckengaust scottschreckengaust force-pushed the docs/migrate-guides-to-docs-dir branch 7 times, most recently from 8dcefb6 to 2e7e808 Compare February 11, 2026 23:58
scottschreckengaust and others added 4 commits February 11, 2026 16:54
  Consolidate role-specific documentation into docs/ directory to reduce
  root-level clutter while following GitHub OSS best practices. Add a new
  maintainers guide covering PR review workflows, roles, merge rules,
  CI/CD overview, and stale automation.

  Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add a dedicated section and boundary rule requiring git worktree usage
for branch work, keeping the main worktree on main at all times.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Rewrite the Roles section in MAINTAINERS_GUIDE.md to document the
team hierarchy: plugin teams set @awslabs/agent-plugins-writers as
their parent team to gain write access, then admins add CODEOWNERS
entries.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@scottschreckengaust scottschreckengaust force-pushed the docs/migrate-guides-to-docs-dir branch from 2e7e808 to f259e53 Compare February 12, 2026 00:54
@scottschreckengaust scottschreckengaust requested review from a team February 12, 2026 15:52
@krokoko krokoko self-requested a review February 12, 2026 17:00
krokoko
krokoko previously approved these changes Feb 12, 2026
@scottschreckengaust scottschreckengaust requested review from a team February 12, 2026 19:13
@scottschreckengaust scottschreckengaust added the documentation Improvements or additions to documentation label Feb 12, 2026
Copy link
Contributor

@scoropeza scoropeza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed, looking good.

@krokoko krokoko self-requested a review February 12, 2026 21:29
@scoropeza scoropeza force-pushed the docs/migrate-guides-to-docs-dir branch from 1f85ff3 to f8c61b8 Compare February 12, 2026 21:30
@scottschreckengaust scottschreckengaust added this pull request to the merge queue Feb 12, 2026
Merged via the queue into main with commit 3e47cfc Feb 12, 2026
23 checks passed
@scottschreckengaust scottschreckengaust deleted the docs/migrate-guides-to-docs-dir branch February 12, 2026 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants