Fix Letter spacing for fonts + Docs improvements

[kotAPI]

Summary by CodeRabbit

• Documentation & Layout

  • Enhanced documentation pages with a centered, constrained container for improved readability.
  • Improved spacing in code blocks and streamlined content by removing outdated sample material.

• Style & Typography

  • Introduced a modern font across the application for a consistent look and feel.
  • Refined heading styles by adjusting letter spacing for greater visual clarity.

• Component Updates

  • Streamlined heading configuration to ensure consistent rendering of title elements.

[coderabbitai]

Walkthrough

This pull request updates multiple areas of the project. GitHub Actions workflows now trigger only when changes occur in specific directories or files. The documentation layout is refined by adding a centered wrapper and removing a placeholder file. Global styles are updated to include a new Google Font. The Heading component has been refactored with an updated type definition, and its corresponding SCSS file now uses adjusted letter-spacing values.

Changes

File(s)	Change Summary
.github/workflows/build-rad-ui.yml, .github/workflows/chromatic.yml	Added paths filters so that the workflows trigger only when changes occur in src/components/ui/**, styles/**, and package.json (for build) or just src/components/ui/**, styles/** (for Chromatic deployment).
docs/app/.../layout.tsx, docs/components/.../Documentation.js, docs/components/.../CodeBlock.js, docs/app/.../page.mdx	Modified documentation layouts by adding a centered wrapper, removing specific outer div styles, adjusting code block spacing, and deleting a placeholder documentation file with metadata.
docs/app/globals.scss	Introduced a new import for the Google Fonts "Inter" family and set the body's font-family accordingly.
src/components/ui/Heading/Heading.tsx, styles/themes/.../heading.scss	Refactored the Heading component by removing the RENDER_AS_ENUMS constant, introducing a new HeadingTag type, and streamlining tag validation; updated letter-spacing values in various heading classes.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub
    participant GA as GitHub Actions
    participant R as Runner

    Dev->>GH: Create pull request / push commit
    GH->>GA: Trigger workflow event (pull_request/push)
    GA->>GA: Evaluate paths filter (e.g., src/components/ui/**, styles/**)
    alt Changes match filter criteria
        GA->>R: Execute build/deployment job
    else No matching changes
        GA-->>Dev: Skip workflow execution
    end

Loading

Possibly Related Issues

• BUG: HeadingComponent fixing TS Lint Error #718: The modifications in Heading.tsx (updating type definitions and removing RENDER_AS_ENUMS) directly address concerns related to improper or missing prop validations.

Possibly Related PRs

• Heading component refactoring #742: Addresses similar changes in the Heading component, specifically updating type definitions and rendering logic.
• Update Chromatic workflow for deployment #487: Involves modifications to the Chromatic workflow configuration, aligning with the current changes.
• CI Step to run build scripts #561: Focuses on refining GitHub Actions build triggers to run based on specific file changes, similar to the updates in this PR.

Suggested Labels

automerge

Suggested Reviewers

• GoldGroove06

Poem

I'm a rabbit with a coder's delight,
Hopping through workflows both day and night.
I tweak the paths so jobs run just right,
And refactor headings with pure insight.
In the garden of code, improvements take flight!
🐰💻

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

docs/components/layout/Documentation/Documentation.js

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

docs/components/layout/Documentation/helpers/CodeBlock.js

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

docs/app/docs/layout.tsx

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9c347ac and 435b860.

📒 Files selected for processing (9)

• .github/workflows/build-rad-ui.yml (1 hunks)
• .github/workflows/chromatic.yml (1 hunks)
• docs/app/docs/layout.tsx (1 hunks)
• docs/app/docs/page.mdx (0 hunks)
• docs/app/globals.scss (1 hunks)
• docs/components/layout/Documentation/Documentation.js (1 hunks)
• docs/components/layout/Documentation/helpers/CodeBlock.js (1 hunks)
• src/components/ui/Heading/Heading.tsx (1 hunks)
• styles/themes/components/heading.scss (1 hunks)

💤 Files with no reviewable changes (1)

• docs/app/docs/page.mdx

🧰 Additional context used

🧬 Code Definitions (1)

docs/app/docs/layout.tsx (1)

docs/components/seo/PageDetails.tsx (1)

• PageDetails (14-45)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build

🔇 Additional comments (17)

docs/app/globals.scss (2)

4-4: Good addition of the Inter font family

Adding the Google Fonts import is a good choice for improving typography throughout the application. The Inter font is excellent for UI design with its clean and modern appearance.

---

6-8: Clean implementation of font-family

Good implementation of the font-family with a proper fallback to sans-serif. This ensures text remains readable even if the Inter font fails to load.

src/components/ui/Heading/Heading.tsx (4)

6-6: Good type safety enhancement

Creating a dedicated HeadingTag type improves type safety and makes the code more maintainable.

---

8-11: Excellent documentation addition

Adding JSDoc comments improves code documentation and helps other developers understand the purpose of the component.

---

12-21: Well-structured props definition

The updated HeadingProps type with documented properties and proper HTML attribute extension is excellent. This ensures all HTML heading attributes are properly supported.

---

23-44: Clean component implementation

The refactored Heading component is well-implemented with:

1. Clear JSDoc documentation
2. Simplified validation logic for heading tags
3. Proper default values
4. Clean use of React.createElement

The validation check on lines 36-38 is a better approach than the previous implementation.

styles/themes/components/heading.scss (6)

5-5: Improved letter-spacing for h1

Adjusting from -3.5px to -3px creates a slightly more readable heading while maintaining the tight aesthetic needed for large headings.

---

12-12: Better readability for h2

Changing from -3px to -1px significantly improves readability for h2 headings while still maintaining a clean look.

---

16-20: Good removal of negative letter-spacing for h3

Removing the negative letter-spacing for h3 improves readability. The default spacing works better for this heading size.

---

22-26: Natural spacing for h4

Removing negative letter-spacing from h4 allows for more natural text flow at this size.

---

31-31: Effective letter-spacing for h5

Changing from negative to positive letter-spacing (1px) for h5 improves readability for smaller heading text.

---

39-39: Consistent styling for h6

Adding 1px letter-spacing to h6 creates consistency with h5 and improves readability for the smallest heading level.

docs/components/layout/Documentation/helpers/CodeBlock.js (1)

41-41: Improved spacing for code blocks

Adding the mb-8 class creates better vertical spacing between code blocks and surrounding content, improving the overall readability and visual organization of the documentation.

.github/workflows/build-rad-ui.yml (1)

6-9: Optimization for CI workflow execution approved.

This change will reduce unnecessary builds by only triggering the workflow when relevant files are modified. The paths filter is appropriately configured to focus on UI components, styles, and package.json which are the files that would necessitate a rebuild.

.github/workflows/chromatic.yml (1)

7-9: Appropriate workflow trigger optimization.

Similar to the build-rad-ui workflow, this change efficiently restricts Chromatic deployments to only run when UI components or styles change. This is consistent with the other workflow while correctly focusing on visual changes only.

docs/app/docs/layout.tsx (1)

21-26: Documentation layout improvement enhances readability.

Adding a centered wrapper with max-width constraint is a good UX improvement that will make the documentation more readable by limiting line length and ensuring content is properly centered on the page. This aligns with the PR objective of improving docs.

docs/components/layout/Documentation/Documentation.js (1)

23-23: Good separation of layout concerns.

Removing the styling classes from this component makes sense as they've been moved to the layout component (layout.tsx). This refactoring improves code organization by properly separating styling responsibilities and applying them consistently at a higher level in the component hierarchy.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.