Skip to content

Studio Agents Suite: Add starter agents.md file amd ship it to site root#2684

Open
katinthehatsite wants to merge 6 commits intotrunkfrom
add/starter-agents-md
Open

Studio Agents Suite: Add starter agents.md file amd ship it to site root#2684
katinthehatsite wants to merge 6 commits intotrunkfrom
add/starter-agents-md

Conversation

@katinthehatsite
Copy link
Contributor

@katinthehatsite katinthehatsite commented Mar 2, 2026

Related issues

Fixes https://linear.app/a8c/issue/STU-1332/create-starter-agentsmd-template
Related to https://linear.app/a8c/issue/STU-1334/implement-auto-placement-of-agentsmd-in-site-root

Proposed Changes

This PR implements the AGENTS.md file to the root of Studio sites. The file includes guidance on Studio CLI commands and usage, WordPress development practices as well as SQLite database documentation.

Testing Instructions

  • Pull the changes from this branch
  • Start Studio with npm start
  • Create a Studio site
  • Navigate to the Overview tab and open the site in Finder
  • Confirm that AGENTS.md file is present in the root of the site
  • Next, open a Terminal and cd into the site
  • Start, for example, Claude
  • Ask Claude about the database integration
  • Confirm that you get the answers related to SQLite database integration
  • Ask Claude about Studio CLI commands
  • Confirm that it gets answers based on the AGENTS.md file

Pre-merge Checklist

  • Have you checked for TypeScript, React or other console errors?

@katinthehatsite katinthehatsite self-assigned this Mar 2, 2026
@katinthehatsite katinthehatsite marked this pull request as draft March 2, 2026 10:05
);
} );

it( 'does not overwrite an existing AGENTS.md', async () => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

For now, we do not overwrite the file. We will consider some more flexibility here to make sure the users get the most recent versions of AGENTS.md shall we have to modify it. It will be solved under https://linear.app/a8c/issue/STU-1332/create-starter-agentsmd-template

@katinthehatsite katinthehatsite requested a review from a team March 2, 2026 13:52
@katinthehatsite katinthehatsite marked this pull request as ready for review March 2, 2026 13:52
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.

1 participant