Add development standards documentation for theme components#47
Add development standards documentation for theme components#47SmolSoftBoi wants to merge 5 commits intoShopify:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds discoverable development standards documentation entrypoints for Shopify theme components by introducing AGENTS.md files that link to the repo’s .cursor/rules/*.mdc standards.
Changes:
- Add root-level
AGENTS.mdindexing standards across CSS/JS/Liquid/HTML and extensive accessibility topics. - Add directory-level
AGENTS.mdfiles (templates/sections/snippets/blocks/etc.) linking to the relevant rules. - (Accidentally) add a
.DS_Storefile to the repository.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | Central index of development standards and accessibility rule references. |
| assets/AGENTS.md | Pointer to asset standards rules. |
| blocks/AGENTS.md | Pointer to block development and schema standards rules. |
| config/AGENTS.md | Pointer to theme settings schema standards rules. |
| locales/AGENTS.md | Pointer to locales/translation standards rules. |
| schemas/AGENTS.md | Pointer to schema standards rules. |
| sections/AGENTS.md | Pointer to section development and schema standards rules. |
| snippets/AGENTS.md | Pointer to snippet/liquid standards rules. |
| templates/AGENTS.md | Pointer to template (JSON) standards rules. |
| .DS_Store | macOS metadata file added (should not be committed). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Schema Standards | ||
|
|
||
| Liquid Rules: [Schema Standards](../.cursor/rules/schemas.mdc) |
There was a problem hiding this comment.
This link points to schemas.mdc, but it’s labeled as "Liquid Rules" here while schemas/AGENTS.md labels the same rule as "Rules". Consider using a consistent label across these docs (e.g., "Schema Rules" / "JSON Rules" / "Rules") to avoid confusion.
| Liquid Rules: [Schema Standards](../.cursor/rules/schemas.mdc) | |
| Rules: [Schema Standards](../.cursor/rules/schemas.mdc) |
| ## Accessibility | ||
|
|
There was a problem hiding this comment.
The ## Accessibility heading is empty and the following ## Global Scope Accessibility Standards is at the same heading level, so the accessibility subsections aren’t actually grouped under the Accessibility section. Consider either removing the empty ## Accessibility header or making Global Scope Accessibility Standards (and the rest) a level deeper (e.g., ###) under it.
| ## Accessibility |
Introduce comprehensive documentation outlining development standards and best practices for various theme components, including CSS, JavaScript, Liquid syntax, accessibility, and schema organization. This aims to enhance consistency and quality across theme development.