Skip to content

feat: adds subdirectory agent md files#6137

Open
marissahuysentruyt wants to merge 22 commits intomainfrom
marissahuysentruyt/feat-agent-md-files
Open

feat: adds subdirectory agent md files#6137
marissahuysentruyt wants to merge 22 commits intomainfrom
marissahuysentruyt/feat-agent-md-files

Conversation

@marissahuysentruyt
Copy link
Copy Markdown
Collaborator

@marissahuysentruyt marissahuysentruyt commented Apr 3, 2026

Description

⚠️ NICE-TO-HAVE PARALLEL MERGE ⚠️
Can be merged directly into feat-agnostic-ai-folder-stuff before or after the washing machine skills PR #6127 or the skills mindset PR #6139

Adds scoped AGENTS.md files under 1st-gen/ and 2nd-gen/ so coding agents (and/or humans) get short, navigational context before diving into code. Each file is intentionally an index: a brief generation/package role, a small directory structure sketch, “where to look next” links to child AGENTS.md files or migration docs - not a full duplicate of CONTRIBUTOR-DOCS.

New files

Path Role
1st-gen/AGENTS.md Past vs future, migration-only changes, link to packages/tools/projects + 2nd-gen
1st-gen/packages/AGENTS.md Component vs tool packages layout, link back to parent + tools/
1st-gen/tools/AGENTS.md Shared tooling bucket
1st-gen/projects/AGENTS.md Non-component workspaces
2nd-gen/AGENTS.md Core vs swc split, build order, links into packages
2nd-gen/packages/core/AGENTS.md Core package: bases, types, what does not belong
2nd-gen/packages/swc/AGENTS.md SWC package: rendering, CSS, stories, tests, what does not belong

Motivation and context

Repo-root AGENTS.md points agents at .ai/, but 1st-gen vs 2nd-gen structure and "core vs swc" boundaries are easy to get wrong without local breadcrumbs. These new files give agents the right mental model in the directory they’re editing and link outward instead of duplicating long guides.

Related issue(s)

  • fixes swc-1893

Screenshots (if appropriate)


Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes.
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
  • Automated tests cover all use cases and follow best practices for writing
  • Validated on all supported browsers
  • All VRTs are approved before the author can update Golden Hash

Manual review test cases

  1. Confirm relative links resolve properly
  • From repo root, open AGENTS.md, then follow into 2nd-gen/AGENTS.md.
  • Continue to follow links into packages/core/AGENTS.md or packages/swc/AGENTS.md
  • Repeat from 1st-gen/AGENTS.md. Go topackages/AGENTS.md, tools/AGENTS.md, projects/AGENTS.md.
  1. Confirm statements match current architecture (package counts, core-before-swc build order, “no new features in 1st-gen” policy).

Device review

  • Did it pass in Desktop?
  • Did it pass in (emulated) Mobile?
  • Did it pass in (emulated) iPad?

Accessibility testing checklist

Required: Complete each applicable item and document your testing steps (replace the placeholders with your component-specific instructions).

Accessibility testing checklist

  • Keyboard
    Documentation only.

  • Screen reader
    Documentation only.

@marissahuysentruyt marissahuysentruyt self-assigned this Apr 3, 2026
@marissahuysentruyt marissahuysentruyt added Status:WIP PR is a work in progress or draft do-not-merge NO MERGE-Y! labels Apr 3, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 3, 2026

⚠️ No Changeset found

Latest commit: dc3bf33

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/feat-agent-md-files branch from 2a9a9e7 to 6a6063b Compare April 3, 2026 16:36
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/feat-agnostic-folder-ai-stuff branch from 1eea82a to 46dfc1d Compare April 6, 2026 12:22
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/feat-agent-md-files branch from 6a6063b to e63d18f Compare April 6, 2026 13:04
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 6, 2026

📚 Branch Preview Links

🔍 First Generation Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-6137

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

@marissahuysentruyt marissahuysentruyt changed the title Marissahuysentruyt/feat agent md files feat: adds subdirectory agent md files Apr 6, 2026
@marissahuysentruyt marissahuysentruyt added 1.0.0 Issues that should be addressed for a 1.0 release! Component:Documentation Issues or PRs involving changes to docs or docs website. Component prefix is for Jira integration. 2nd gen These issues or PRs map to our 2nd generation work to modernizing infrastructure. and removed Status:WIP PR is a work in progress or draft labels Apr 6, 2026
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/feat-agnostic-folder-ai-stuff branch from 7bdadee to 117b2a4 Compare April 8, 2026 17:21
@marissahuysentruyt marissahuysentruyt force-pushed the marissahuysentruyt/feat-agent-md-files branch from e63d18f to c53e7af Compare April 8, 2026 17:41
Base automatically changed from marissahuysentruyt/feat-agnostic-folder-ai-stuff to main April 13, 2026 19:25
@caseyisonit caseyisonit marked this pull request as ready for review April 13, 2026 19:56
@caseyisonit caseyisonit requested a review from a team as a code owner April 13, 2026 19:56
@caseyisonit caseyisonit added Status:Ready for review PR ready for review or re-review. and removed do-not-merge NO MERGE-Y! labels Apr 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1.0.0 Issues that should be addressed for a 1.0 release! 2nd gen These issues or PRs map to our 2nd generation work to modernizing infrastructure. Component:Documentation Issues or PRs involving changes to docs or docs website. Component prefix is for Jira integration. Status:Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants