Update Eclipse docs with new Tokens section#7637
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (4)
WalkthroughRestructures the Eclipse Design System docs: removes Atoms and Molecules metadata files, adds Tokens and Components metadata, updates root meta.json and index.mdx, and introduces new Tokens docs for spacing and typography plus a small change to colors content. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📝 Coding Plan for PR comments
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 |
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
apps/eclipse/content/design-system/tokens/meta.json (1)
3-3: Minor grammatical improvement in description.The phrase "Design tokens components" reads awkwardly. Consider simplifying to maintain consistency with the Components meta.json style.
✏️ Suggested fix
- "description": "Design tokens components in the Eclipse Design System", + "description": "Design tokens in the Eclipse Design System",🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/eclipse/content/design-system/tokens/meta.json` at line 3, Update the "description" value in meta.json to a clearer, grammatically correct phrase — replace "Design tokens components in the Eclipse Design System" with something like "Design tokens for the Eclipse Design System" or "Design tokens in the Eclipse Design System"; locate the "description" key in the file to make the change so it matches the Components meta.json style.apps/eclipse/content/design-system/tokens/typography.mdx (1)
32-32: Consider simplifying phrasing.The phrase "with the exception of" is correct but a bit verbose for documentation. A simpler alternative reads more smoothly.
✏️ Suggested simplification
-Heading styles use the **Mona Sans VF** display font, with the exception of `heading-2xs`. Use these styles only for headings. +Heading styles use the **Mona Sans VF** display font, except for `heading-2xs`. Use these styles only for headings.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/eclipse/content/design-system/tokens/typography.mdx` at line 32, The sentence "Heading styles use the **Mona Sans VF** display font, with the exception of `heading-2xs`. Use these styles only for headings." is wordy; replace "with the exception of" with the simpler "except" so it reads "Heading styles use the **Mona Sans VF** display font, except `heading-2xs`. Use these styles only for headings." Update the copy where that exact string appears (reference: the heading token `heading-2xs`) to use the simplified phrasing.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@apps/eclipse/content/design-system/tokens/spacing.mdx`:
- Line 211: The class name contains a typo: replace the double-dash token
"min-h--element-xl" with the correct "min-h-element-xl" in the JSX element so it
matches the project's single-dash spacing tokens (see other tokens like
h-element-xl, w-element-3xl, size-element-xl used in button.tsx and avatar.tsx);
update the className string inside the component to the single-dash variant to
restore consistent naming and Tailwind/CSS-token compatibility.
---
Nitpick comments:
In `@apps/eclipse/content/design-system/tokens/meta.json`:
- Line 3: Update the "description" value in meta.json to a clearer,
grammatically correct phrase — replace "Design tokens components in the Eclipse
Design System" with something like "Design tokens for the Eclipse Design System"
or "Design tokens in the Eclipse Design System"; locate the "description" key in
the file to make the change so it matches the Components meta.json style.
In `@apps/eclipse/content/design-system/tokens/typography.mdx`:
- Line 32: The sentence "Heading styles use the **Mona Sans VF** display font,
with the exception of `heading-2xs`. Use these styles only for headings." is
wordy; replace "with the exception of" with the simpler "except" so it reads
"Heading styles use the **Mona Sans VF** display font, except `heading-2xs`. Use
these styles only for headings." Update the copy where that exact string appears
(reference: the heading token `heading-2xs`) to use the simplified phrasing.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 77d560e9-df6f-4a01-8429-d4f938993e8f
📒 Files selected for processing (41)
apps/eclipse/content/design-system/atoms/meta.jsonapps/eclipse/content/design-system/components/accordion.mdxapps/eclipse/content/design-system/components/action.mdxapps/eclipse/content/design-system/components/alert.mdxapps/eclipse/content/design-system/components/avatar.mdxapps/eclipse/content/design-system/components/badge.mdxapps/eclipse/content/design-system/components/banner.mdxapps/eclipse/content/design-system/components/breadcrumb.mdxapps/eclipse/content/design-system/components/button.mdxapps/eclipse/content/design-system/components/card.mdxapps/eclipse/content/design-system/components/chart.mdxapps/eclipse/content/design-system/components/checkbox.mdxapps/eclipse/content/design-system/components/codeblock.mdxapps/eclipse/content/design-system/components/dialog.mdxapps/eclipse/content/design-system/components/dropdownmenu.mdxapps/eclipse/content/design-system/components/field.mdxapps/eclipse/content/design-system/components/files.mdxapps/eclipse/content/design-system/components/inlinetoc.mdxapps/eclipse/content/design-system/components/input.mdxapps/eclipse/content/design-system/components/label.mdxapps/eclipse/content/design-system/components/meta.jsonapps/eclipse/content/design-system/components/pagination.mdxapps/eclipse/content/design-system/components/radio-group.mdxapps/eclipse/content/design-system/components/separator.mdxapps/eclipse/content/design-system/components/slider.mdxapps/eclipse/content/design-system/components/spinner.mdxapps/eclipse/content/design-system/components/statistic.mdxapps/eclipse/content/design-system/components/steps.mdxapps/eclipse/content/design-system/components/switch.mdxapps/eclipse/content/design-system/components/table.mdxapps/eclipse/content/design-system/components/tabs.mdxapps/eclipse/content/design-system/components/textarea.mdxapps/eclipse/content/design-system/components/tooltip.mdxapps/eclipse/content/design-system/components/typetable.mdxapps/eclipse/content/design-system/index.mdxapps/eclipse/content/design-system/meta.jsonapps/eclipse/content/design-system/molecules/meta.jsonapps/eclipse/content/design-system/tokens/colors.mdxapps/eclipse/content/design-system/tokens/meta.jsonapps/eclipse/content/design-system/tokens/spacing.mdxapps/eclipse/content/design-system/tokens/typography.mdx
💤 Files with no reviewable changes (2)
- apps/eclipse/content/design-system/atoms/meta.json
- apps/eclipse/content/design-system/molecules/meta.json
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
1 participant
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
atoms/molecules split
live previews and reference tables
Test plan
Summary by CodeRabbit
New Features
Documentation
Chores