Conversation
Contributor
Hello cuervino,My role is to assist you with the merge of this Available options
Available commands
Status report is not available. |
Contributor
Waiting for approvalThe following approvals are needed before I can proceed with the merge:
Peer approvals must include at least 1 approval from the following list: |
| The package ships the design system guidelines in `stories/`: | ||
|
|
||
| - `stories/<Component>/<component>.guideline.mdx`: when and how to use a component. A few older ones sit directly under `stories/`, such as `form.guideline.mdx`. | ||
| - The other `.mdx` files directly under `stories/` and under `stories/guideline/`: rules for every screen, such as typography, formats and the design principles in `Introduction.mdx`. |
Contributor
There was a problem hiding this comment.
stories/guideline/docs-template.mdx is a blank authoring template ("Component name", "General description"), not a rule, and it ships too. An agent told to read every .mdx under stories/guideline/ will read it as guidance. Exclude it here and in the agent line below, or move it out of stories/guideline/.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The guidelines are shipped in the npm package, under
stories/, but nothing tells a consumer to read them. A mockup generated by an agent broke three rules that were already written (Toggle in a form with a Save button, delete modal without the resource name, "Done" on a read-only modal).The README gets a Guidelines section: where the guideline files are in the package, what to read before using a component or building a screen, and a line to add to a project's
CLAUDE.mdorAGENTS.md, since agents only read the instruction file of the project they work in.