Skip to content

chore: merge strands-agents/docs into monorepo#2339

Merged
zastrowm merged 567 commits into
strands-agents:mainfrom
zastrowm:merge-in-the-docs-repository
May 27, 2026
Merged

chore: merge strands-agents/docs into monorepo#2339
zastrowm merged 567 commits into
strands-agents:mainfrom
zastrowm:merge-in-the-docs-repository

Conversation

@zastrowm
Copy link
Copy Markdown
Member

@zastrowm zastrowm commented May 27, 2026

Description

This is the first of several repository merges as part of the monorepo convergence (see #2286). Subsequent merges will bring in sdk-typescript, mcp-server, and devtools.

Merge the strands-agents/docs repository into the monorepo with full commit history preserved (564 commits). The docs repo's content lands at site/ (Astro documentation site) and designs/ (design documents at repo root), matching the layout defined in the convergence plan.

Key decisions:

  • All docs workflows already carried a docs- prefix with path filters (site/**, .github/workflows/docs-*) — no renaming needed
  • .gitignore updated to allow .kiro/skills and .kiro/references symlinks (pointing to .agents/)
  • site/.gitignore un-gitignored package-lock.json and a lockfile was generated so npm ci works in CI
  • dependabot.yml gained an npm entry for /site with ci(docs) commit prefix
  • Docs-specific issue templates (content_addition, documentation_improvement, documentation_question, technical_correction) merged alongside existing SDK templates
  • Agent skills and references (.agents/) brought in for docs workflow tooling
  • Removed docs-auto-strands-review.yml (shared auto-strands-review.yml already covers it)

Conflict resolutions:

File Resolution
README.md Monorepo version (ours)
.github/PULL_REQUEST_TEMPLATE.md Monorepo version (ours)
.gitignore Monorepo patterns + .kiro rule relaxed for symlinks
.github/dependabot.yml Merged — added npm /site entry

CI merge-gate workflow

Adds a new ci.yml workflow that solves the monorepo path-filtering problem: when required status checks come from path-filtered workflows, PRs that don't touch those paths can never merge because the checks never report.

How it works:

  • ci.yml always runs on PRs, uses dorny/paths-filter to detect which areas changed
  • Conditionally invokes python-test-lint.yml and/or docs-ci.yml via workflow_call
  • A final CI Gate job (using re-actors/alls-green) aggregates results — skipped jobs pass, failed jobs fail
  • Individual workflows (python-pr-and-push.yml, docs-ci.yml) no longer have pull_request triggers to avoid duplicate runs

Ruleset change required: Replace the 10 individual call-test-lint/* required checks with a single CI Gate check.

Related Issues

#2286

Documentation PR

N/A — this PR is the docs merge.

Type of Change

Other (please describe): Repository convergence — merging docs repo history into the monorepo + CI gate workflow.

Testing

Both workflows validated on fork (zastrowm/sdk-python) via workflow_dispatch and on the PR itself:

  • CI Gate — passed (Python skipped correctly on docs-only changes, Docs CI ran and passed)

  • CI Gate — passed (both Python and Docs ran when workflow files were touched)

  • Python: Pull Request and Push — no longer triggers on PRs (only push-to-main + dispatch)

  • I ran hatch run prepare

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

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

zastrowm and others added 30 commits January 30, 2026 15:43
Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
…ents#505)

Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
…agents#514)

Co-authored-by: strands-agent <217235299+strands-agent@users.noreply.github.com>
Co-authored-by: Patrick Gray <pgrayy@amazon.com>
…ents#504)

Co-authored-by: Francesco Cerizzi <francesco@MacBook-Pro-di-Francesco.local>
Co-authored-by: Strands Agent <217235299+strands-agent@users.noreply.github.com>
…agents#522)

Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
…s#527)

Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
…agents#541)

Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
@zastrowm zastrowm marked this pull request as ready for review May 27, 2026 20:01
Comment thread .github/workflows/docs-ci.yml Outdated
Comment thread .github/workflows/docs-ci.yml Outdated
Comment thread .github/workflows/ci.yml
Comment thread .github/workflows/docs-strands-command.yml
@github-actions
Copy link
Copy Markdown
Contributor

Assessment: Comment

The CI gate architecture is well-designed — the dorny/paths-filter + alls-green pattern is a clean solution to the monorepo path-filtering problem, and the authorization checks on pull_request_target workflows follow existing repo patterns.

Review Categories
  • CI Consistency: Docs workflows brought in from the old repo use older action versions (@v4) and npm install instead of npm ci, diverging from the conventions already established in this monorepo.
  • Coverage Gap: Changes to ci.yml itself don't trigger any test suite, meaning a broken gate workflow could be merged without validation.
  • Stale References: designs/README.md still points to the now-merged docs repo for submissions.
  • Security: The deploy preview workflow's pull_request_target + head checkout pattern is appropriately gated but could benefit from inline documentation of the security model.

Solid convergence work — the conflict resolution table in the PR description is particularly helpful for reviewers.

JackYPCOnline
JackYPCOnline previously approved these changes May 27, 2026
- Remove docs-auto-strands-review.yml (shared workflow covers it)
- Upgrade actions/checkout and actions/setup-node from @v4 to @v6
- Upgrade actions/github-script from @v7 to @v8
- Switch npm install to npm ci in CI workflows for deterministic builds
- Add .github/workflows/ci.yml to path filters so changes to the
  gate itself trigger both test suites
Comment thread .github/workflows/docs-deploy-preview.yml
@github-actions
Copy link
Copy Markdown
Contributor

Assessment: Approve

The updates since the last review addressed the key feedback — action versions, npm ci, and path filter coverage are all resolved. One minor consistency item remains (aws-actions/configure-aws-credentials@v4@v6 in deploy preview).

Remaining Items
  • Action version: docs-deploy-preview.yml still uses aws-actions/configure-aws-credentials@v4 while the rest of the repo uses @v6
  • Node version: docs-strands-command.yml uses Node 20 vs 22 elsewhere (may be constrained by the agent-runner action)
  • Stale reference: designs/README.md still points to the now-merged docs repo for submissions

Clean convergence work — the CI gate pattern is solid and the workflow consolidation is well thought through.

@zastrowm zastrowm merged commit cbc72e5 into strands-agents:main May 27, 2026
27 of 38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-community Related to community and contributor health size/xl

Projects

None yet

Development

Successfully merging this pull request may close these issues.