chore: improve Claude Code config and docs#2585
Open
balzss wants to merge 1 commit into
Open
Conversation
|
Visual regression report✅ No changes.
Baselines come from the |
balzss
force-pushed
the
claude-config-improvements
branch
from
a842707 to
05d09a8
Compare
joyenjoyer
requested changes
Jun 10, 2026
| ## Finding component info | ||
|
|
||
| ## Quick Start | ||
| 1. **Start with the component README**: `/packages/<pkg>/src/<Component>/README.md` — this is the source for the published docs and has examples + prop descriptions. |
Contributor
There was a problem hiding this comment.
I would add a sentence about multi version support explaining what v1 v2 means for example.
Contributor
Author
There was a problem hiding this comment.
Good call — added a short "Component versioning (v1/v2)" section explaining v1 = legacy, v2 = preferred. Thanks! 🙏
| InstUI uses custom markdown with special code blocks (using [gray-matter](https://github.com/jonschlinkert/gray-matter) YAML syntax) for interactive examples. | ||
|
|
||
| **Code block types:** | ||
|
|
Contributor
There was a problem hiding this comment.
I would keep this info so Claude understands the docs structure.
Contributor
Author
There was a problem hiding this comment.
Fair — inlined a brief summary of the code/embed/example block types right in CLAUDE.md (kept the link to writing-docs.md for the full reference). Thanks!
matyasf
requested changes
Jun 11, 2026
- Rewrite CLAUDE.md as a minimal, non-derivable reference (~45 lines, down from 200+). - Tighten /commit and /pr slash commands: pin gh to --body-file -, drop CI-covered items from test plan, note commitlint's 100-char body line limit. - Add .claude/settings.json with a read-only safe-command allowlist (git/pnpm/gh/file-search). - Ignore CLAUDE.local.md for personal overrides. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
balzss
force-pushed
the
claude-config-improvements
branch
from
05d09a8 to
d3d60a6
Compare
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
3 participants
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.
Summary
CLAUDE.mdas a minimal, non-derivable reference (~45 lines, from 200+); drop dead path topackages/__docs__/src/components.tsand content Claude can infer from the code./commitand/prslash commands: pinghto--body-file -, exclude CI-covered items from the test plan, drop duplicated breaking-change rules..claude/settings.jsonwith a read-only/safe-command allowlist so commonpnpm/git/gh/file-search commands stop prompting.CLAUDE.local.mdso devs can keep personal overrides uncommitted.Test Plan
Fixes INSTUI-5060
🤖 Generated with Claude Code