feat: Add AI agent docs#11881
Conversation
… guidelines for contributing to the docs. This includes instructions for adding new topics and updating general guidance.
…ns and add a new checklist for creating components. Emphasize the preference for using `Ol` prefix over `OL` for new components.
|
Also related: #11887 -- I wonder if we can reconcile |
|
@mekarpeles I still wanted to give feedback. I'm not sure if you've read the docs on copilot but I don't think this follows them. |
| @@ -0,0 +1,39 @@ | |||
| # Copilot Instructions | |||
There was a problem hiding this comment.
I think this file actually has to be in an .github/agents/ dir
|
@RayBB the approach @lokesh put in place DRY's documentation into a single readme and also contains a single high-level AGENTS.md. Github suggests using |
|
@mekarpeles The following markdown block is also repeated in 4 files part of this PR. |
|
There is some code duplication here, but this PR enables support for multiple tools and we get the benefits now, rather than waiting for a perfect AI docs architecture design. On maintainability: the bridge files should be stable and only require occasional updates, and if they get out of sync, they are a prompt away from getting realigned. Most importantly, the standards for AI docs are evolving, and I expect we'll be moving, renaming, and reorganizing files and content in the future. These files are not precious, better to start and iterate than wait. |
[feature] Add AI instruction bridge: one canonical guide, thin wrappers for each AI tool
Note: In the spirit of this direction, most of the PR description text is AI generated, though edited and verified by me.
Sets up a maintainable system for guiding AI coding assistants (Claude Code, OpenAI Codex, GitHub Copilot, Cursor). A single canonical guide lives at
docs/ai/README.md; each tool gets a minimal bridge file in the location it natively discovers.Files added/changed:
docs/ai/README.mdCLAUDE.mdAGENTS.md.github/copilot-instructions.mdNo
.cursorrulesfile is added — Cursor readsAGENTS.mdnatively and.cursorrulesis legacy/deprecated.Technical
docs/ai/README.md).docs/ai/README.mdwhen project guidance changes. The bridges should rarely need touching - they contain only stable quick-reference content (commands, style rules, entry points).Testing
Screenshot
Stakeholders
@mekarpeles @cdrini @jimchamp