Skip to content

docs(many): add Claude Code configuration and documentation#2182

Merged
balzss merged 4 commits intomasterfrom
chore/claude-config
Oct 10, 2025
Merged

docs(many): add Claude Code configuration and documentation#2182
balzss merged 4 commits intomasterfrom
chore/claude-config

Conversation

@balzss
Copy link
Contributor

@balzss balzss commented Oct 7, 2025

Summary

Adds comprehensive Claude Code and AI assistant support to the repository, configures custom slash commands for InstUI workflows, and removes outdated npm workaround packages.

Changes

  • CLAUDE.md: Complete documentation covering repository structure, development workflows, component conventions, testing strategies, commit workflow, and documentation writing guidelines
  • .claudeignore: Optimized file exclusions for better Claude Code performance
  • .gitignore: Added entries for AI tool artifacts and selective tracking of Claude Code commands
  • ai-features.md: Updated to reference CLAUDE.md for Claude Code usage
  • inst-ai.config.mjs: Configuration for inst-ai integration
  • .claude/commands/: Added /commit and /pr slash commands following InstUI conventions
  • package.json: Removed jsdom and @rollup/rollup-linux-x64-gnu workaround packages (npm v11.6.0+ resolved the issue)

Test Plan

  1. Verify CLAUDE.md is readable and comprehensive
  2. Test /commit command creates properly formatted commits with HUSKY=0
  3. Test /pr command creates PRs following InstUI conventions
  4. Verify workaround package removal doesn't break builds

Related

🤖 Created with Claude Code

@balzss balzss self-assigned this Oct 7, 2025
@balzss balzss requested review from ToMESSKa and matyasf October 7, 2025 16:39
@balzss balzss marked this pull request as ready for review October 7, 2025 16:42
@github-actions
Copy link

github-actions bot commented Oct 7, 2025

PR Preview Action v1.6.2
Preview removed because the pull request was closed.
2025-10-10 12:06 UTC

@balzss balzss force-pushed the chore/claude-config branch from e7b074a to e0e8c61 Compare October 8, 2025 14:20
Copy link
Collaborator

@matyasf matyasf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • update .env.template

balzss and others added 3 commits October 8, 2025 18:11
Add comprehensive AI assistant support:
- CLAUDE.md with repository structure, workflows, and conventions
- .claudeignore to optimize Claude Code performance
- .gitignore entries for AI tool artifacts
- Updated ai-features.md to reference CLAUDE.md
- inst-ai.config.mjs for inst-ai integration

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Remove jsdom and @rollup/rollup-linux-x64-gnu packages that were added
as a temporary workaround for npm v11.5.0 bug. The issue has been
resolved in npm v11.6.0+.

Related: npm/cli#8470

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Add shared slash commands for InstUI workflow:
- /commit: Create commits following InstUI conventions with HUSKY=0
- /pr: Create pull requests following InstUI conventions

Update .gitignore to track only shared commands while ignoring
user-specific local commands.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@balzss balzss force-pushed the chore/claude-config branch from e0e8c61 to 98693e1 Compare October 8, 2025 16:11
@balzss balzss requested a review from matyasf October 8, 2025 16:14
Copy link
Collaborator

@matyasf matyasf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, just a few nitpicks

CLAUDE.md Outdated
2. **Package README**: `/packages/[package]/README.md`
- Package overview, installation, exports

**For complete API details:**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For complete API details of a component:

Improve CLAUDE.md with:
- Clarify that component READMEs render instructure.design docs
- Simplify component development workflow steps
- Add gray-matter reference for documentation syntax
- Refine wording for better clarity

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@matyasf matyasf self-requested a review October 10, 2025 08:52
Copy link
Collaborator

@matyasf matyasf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me

@balzss balzss merged commit 14a4b02 into master Oct 10, 2025
11 checks passed
@balzss balzss deleted the chore/claude-config branch October 10, 2025 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants