Add CLAUDE.md #353
Add CLAUDE.md #353
Conversation
✅ Deploy Preview for docs-ui ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThis PR introduces a new CLAUDE.md documentation file providing guidance for Claude Code on repository structure, build commands, architecture, and development workflow. It also modifies src/partials/head-info.hbs to conditionally render keywords metadata when either page.keywords or page.attributes.page-commercial-names exists, concatenating both sources when applicable. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @CLAUDE.md:
- Around line 93-95: Update the documented Go requirement: change the Go version
line currently saying "Go 1.23.4+ (for building WASM modules)" to "Go 1.22.3+"
so the CLAUDE.md minimum Go version matches the console-config-migrator
requirement; leave a comment or note nearby (if needed) that blobl-editor
requires Go 1.25.4 separately, but ensure the main minimum line reads "Go
1.22.3+".
🧹 Nitpick comments (2)
src/partials/head-info.hbs (1)
28-30: Logic is correct; consider improving readability.The keywords concatenation logic correctly handles all cases (keywords only, commercial names only, both, or neither). However, the single-line template at line 29 is dense and difficult to parse at a glance.
♻️ Optional refactor for improved readability
Breaking the template into multiple lines would make the logic more maintainable:
{{#if (or page.keywords page.attributes.page-commercial-names)}} - <meta name="keywords" content="{{#with page.keywords}}{{{this}}}{{#if @root.page.attributes.page-commercial-names}}, {{/if}}{{/with}}{{#with page.attributes.page-commercial-names}}{{{this}}}{{/with}}"> + <meta name="keywords" content="{{~#with page.keywords~}} + {{{this}}}{{#if @root.page.attributes.page-commercial-names}}, {{/if}} + {{~/with~}} + {{~#with page.attributes.page-commercial-names~}} + {{{this}}} + {{~/with~}}"> {{/if}}The
~characters suppress whitespace, maintaining the same output while improving readability.CLAUDE.md (1)
12-12: Fix bare URL markdown formatting.The URL should be wrapped in angle brackets per markdown conventions.
♻️ Proposed fix
-- `gulp preview` - Build UI and start local preview server at http://localhost:5252 with live reload +- `gulp preview` - Build UI and start local preview server at <http://localhost:5252> with live reload
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
CLAUDE.mdsrc/partials/head-info.hbs
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
CLAUDE.md
12-12: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - docs-ui
- GitHub Check: Header rules - docs-ui
- GitHub Check: build
- GitHub Check: Pages changed - docs-ui
🔇 Additional comments (1)
CLAUDE.md (1)
1-113: Excellent documentation for developer and AI onboarding.This documentation provides comprehensive coverage of the project structure, build system, commands, and development workflow. The organization is clear and the level of detail is appropriate for both human developers and AI assistants working with the codebase.
Move appendTo and popperOptions settings to shared tooltipConfig so all tooltips including glossary terms prevent overflow clipping.
Generated using the
/initcommand in Claude Code.This pull request introduces a new guidance document for Claude Code and improves the SEO metadata for documentation pages by updating how keywords are generated in the HTML head. The most notable changes are:
Documentation and Developer Guidance:
CLAUDE.mdfile that explains the project structure, build system, key commands, architecture, and contribution guidelines. This serves as an onboarding and reference guide for developers and AI code assistants working with the repository.SEO and Metadata Enhancements:
src/partials/head-info.hbstemplate to improve the generation of thekeywordsmeta tag. Now, bothpage.keywordsandpage-commercial-namesattributes are included, if present, resulting in richer and more accurate metadata for search engines.