Studio Agents Suite: Add starter agents.md file and ship it to site root#2684
Studio Agents Suite: Add starter agents.md file and ship it to site root#2684katinthehatsite merged 8 commits intotrunkfrom
Conversation
| ); | ||
| } ); | ||
|
|
||
| it( 'does not overwrite an existing AGENTS.md', async () => { |
There was a problem hiding this comment.
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
epeicher
left a comment
There was a problem hiding this comment.
Thanks @katinthehatsite for adding that! I have reviewed the Agents.md and it looks great, we can iterate over it as we use it (if required) but it's a great starting point in my opinion.
have added a couple of comments for consideration, the main one about externalising the file, but interested in other points of view.
|
|
||
| const AGENTS_MD_FILENAME = 'AGENTS.md'; | ||
|
|
||
| const AGENTS_MD_TEMPLATE = `# AI Instructions |
There was a problem hiding this comment.
Have we considered extracting this template to an external .md file for easier maintenance?
There was a problem hiding this comment.
Yeah I initially did that :) Then, I went back on it but I think we will have to do it regardless based on my exploration in #2698
I will move it in that PR if that's okay so that I don't have to do another rebase 😅
There was a problem hiding this comment.
I will move it in that PR if that's okay so that I don't have to do another rebase
That's fine 👍
📊 Performance Test ResultsComparing 00f3022 vs trunk site-editor
site-startup
Results are median values from multiple test runs. Legend: 🟢 Improvement (faster) | 🔴 Regression (slower) | ⚪ No change (<50ms diff) |

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.mdfile 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
npm startOverviewtab and open the site inFinderAGENTS.mdfile is present in the root of the sitecdinto the siteAGENTS.mdfilePre-merge Checklist