refactor: make SKILL.md source of truth, generate prompt.md from it

This commit is contained in:
Tommy D. Rossi
2026-01-24 12:21:22 +01:00
parent f9869a59f2
commit b7edfb52b1
9 changed files with 111 additions and 561 deletions
+3 -3
View File
@@ -3,7 +3,7 @@ this is the playwriter codebase
the extension uses chrome.debugger to manage the user browser
read ./README.md for an overview of how this extension and mcp work
read playwriter/src/prompt.md to understand how the MCP works
read skills/playwriter/SKILL.md to understand the MCP docs (source of truth)
## backward compatibility
@@ -32,11 +32,11 @@ extension/ contains the chrome extension code. you need to run `pnpm build` to m
when I ask you to release extension run package.json release script
playwriter contains the ws server and MCP code. also the tests for the mcp are there. playwriter/src/prompt.md contains the docs for the MCP the agent will use. you should add there important sections that help the agent control the browser well with the MCP interface
playwriter contains the ws server and MCP code. also the tests for the mcp are there. skills/playwriter/SKILL.md is the source of truth for MCP docs - edit that file to update agent instructions. the build script generates playwriter/src/prompt.md (gitignored) from SKILL.md, stripping CLI-only sections.
playwriter/src/resource.md is for more generic knowledge about playwright that the agent can use when necessary, for things like best practices for selecting locators on the page
website/public/resources/ is auto-generated by `playwriter/scripts/build-resources.ts` during `pnpm build`. DO NOT edit these files manually - edit the source files in `playwriter/src/` instead (e.g. `debugger-examples.ts`, `editor-examples.ts`, `styles-examples.ts`)
website/public/resources/ and website/public/SKILL.md are auto-generated by `playwriter/scripts/build-resources.ts` during `pnpm build`. DO NOT edit these files manually - edit the source files instead (e.g. `debugger-examples.ts`, `editor-examples.ts`, `styles-examples.ts`, `skills/playwriter/SKILL.md`)
## CDP docs