better-design 0.37.0 → 0.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -4
- package/dist/index.js +21168 -20195
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -62,10 +62,38 @@ the tools store nothing.
|
|
|
62
62
|
|
|
63
63
|
## Share your team's rules with every agent
|
|
64
64
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
65
|
+
Your team's rules are one Markdown document of up to 32 KB. `get-team-rules`
|
|
66
|
+
gives them to any agent that uses your key, `get-review-rules` checks the work
|
|
67
|
+
against them, and `check-comprehension` fails copy that uses a word they ban.
|
|
68
|
+
|
|
69
|
+
When you have no rules yet, `get-team-rules` hands your agent an outline. The
|
|
70
|
+
agent drafts the rules with you from your project and your live site, and
|
|
71
|
+
`set-team-rules` saves them once you approve the draft. You can also paste them
|
|
72
|
+
into [Team rules](https://better-design.com/dashboard/settings/team-rules).
|
|
73
|
+
|
|
74
|
+
When you correct a choice your agent made, and the correction should hold for
|
|
75
|
+
every build, `propose-team-rule` turns it into one proposed rule. It waits on
|
|
76
|
+
the Team rules page, and no agent follows it until you approve it there.
|
|
77
|
+
|
|
78
|
+
A client project keeps its own rules beside its design system: one guidelines
|
|
79
|
+
document, a use, never or pairing rule for each part or value, a ban for the
|
|
80
|
+
whole brand, and specs on a screen or on one part of it. Pass `projectId` to
|
|
81
|
+
`set-team-rules` to save one piece. Pass `projectId`, `screen` and `parts` to
|
|
82
|
+
`get-team-rules`, and the agent gets only what that screen needs.
|
|
83
|
+
|
|
84
|
+
To reach agents that never call these tools, a local model included, run this
|
|
85
|
+
at the root of your repository:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
npx better-design rules
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
It writes your team rules, the components your review settings name, and the
|
|
92
|
+
AI-feature rules in short into `AGENTS.md`, and into `CLAUDE.md` when the
|
|
93
|
+
repository keeps one. Every agent reads that file before each task. The
|
|
94
|
+
command shows your team rules and asks before it writes them; in a script, add
|
|
95
|
+
`--yes` once a person has read them. Commit the file, and run the command again
|
|
96
|
+
when the rules change.
|
|
69
97
|
|
|
70
98
|
## Report a bug or a missing feature
|
|
71
99
|
|