Skip to content

feature/docs/20260529#451

Merged
domix merged 4 commits into
mainfrom
feature/docs/20260529
May 29, 2026
Merged

feature/docs/20260529#451
domix merged 4 commits into
mainfrom
feature/docs/20260529

Conversation

@domix

@domix domix commented May 29, 2026

Copy link
Copy Markdown
Owner
  • docs(guide): add module ecosystem diagram to introduction
  • feat(site): modernize guide index with hero, color-coded cards, and responsive grid
  • feat(site): modernize home page with value props, color-coded types, and improved hero buttons

Pull Request

📌 Summary

Briefly describe the purpose of this pull request and what problem it solves.

Example: This PR adds a functional implementation of a lazy list, demonstrating deferred computation using Java 17 features.


✅ Checklist

Please check all that apply:

  • I have tested my changes locally
  • I have added unit tests where applicable
  • I have updated documentation where necessary
  • My code follows the project's coding conventions
  • I have linked any related issue(s) below

🔗 Related Issues

Closes #[issue-number]
Fixes #[issue-number]
(Related but not closing: #[issue-number])


💬 Additional Notes

Any other context, screenshots, design decisions, or points to be reviewed carefully.

Summary by CodeRabbit

  • Documentation
    • Redesigned the Developer Guide page with color-coded sections, enhanced navigation, and decision table for improved usability.
    • Updated homepage with new features section, color-coded type and module cards, and refreshed visual design.
    • Added ecosystem visualization to guide introduction.

Review Change Stack

domix added 3 commits May 29, 2026 14:32
…esponsive grid

  Add gradient hero with CTA buttons, quick-nav type pills, a decision
  lookup table with per-type color badges, and a 3→2→1 column card grid
  with 11 semantic accent colors per category. Modules and contributing
  sections use compact grids. Fully responsive across desktop, tablet,
  and mobile.
…and improved hero buttons

  Replace plain intro card with a 3-column value proposition strip.
  Add gradient+glow primary CTA, glass-border secondary CTA, and GitHub
  icon button to the hero. Apply color-coded type tags across the types
  and modules grids. Compact section headers with inline "Full reference"
  links. Responsive 4→2→1 column type grid and 3→2→1 modules grid.
@domix domix added the site Website and documentation site changes label May 29, 2026
@domix domix self-assigned this May 29, 2026
@coderabbitai

coderabbitai Bot commented May 29, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@domix, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 48 minutes and 5 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2f2191a5-2961-422e-8c7c-a352e60ecf54

📥 Commits

Reviewing files that changed from the base of the PR and between 6e73dec and 09d7c8e.

📒 Files selected for processing (1)
  • site/src/pages/guide/index.astro
📝 Walkthrough

Walkthrough

This PR redesigns the homepage and guide pages with a unified tag-color system. Both pages introduce tagColor mappings, restructure their data models, rebuild page layouts with new markup, and apply comprehensive CSS overhauls. The guide introduction is additionally enhanced with a centered ecosystem image.

Changes

Page UI Redesign

Layer / File(s) Summary
Homepage redesign
site/src/pages/index.astro
Homepage introduces a tagColor map and restructures types, modules, and a new features array with SVG icons. The page layout is rewritten with a hero section, features grid, core types grid, quick example, optional modules grid, installation section, and updated CTA. CSS is entirely replaced with new styling for the redesigned components and tag color system.
Guide page redesign
site/src/pages/guide/index.astro
Guide page introduces a tagColor map and redefines types, modules, contributing, and decisions arrays to power new UI components. Page structure includes a hero, quick navigation pills, a decision table, core type cards with "Use when"/"Avoid when" text, cross-type composition callout, and modules/contributing cards. CSS is overhauled with full layout/grid styling, tag-based color system, and responsive breakpoints.
Guide ecosystem image
site/src/data/guide/introduction.mdx
Guide introduction is enhanced with a centered HTML block containing an ecosystem image inserted between the "Available modules" introductory text and the artifact table.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • domix/dmx-fun#215: Both PRs modify the homepage and guide layouts with the new type/module rendering system and styling.

Suggested labels

documentation

Poem

🐰 Two pages bloom with colors bright,
Tags and types now guide the sight,
Grids and heroes, features shine,
An ecosystem image joins the line! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'feature/docs/20260529' is vague and generic, using only a date without describing the actual changes made. Revise the title to clearly describe the main changes, such as 'Modernize home page and guide with color-coded cards and hero sections' or 'Add module ecosystem diagram and redesign guide/home pages'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The description includes the template with checked items for local testing and documentation updates, but related issue numbers are missing and additional notes section is empty.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/docs/20260529

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
site/src/pages/index.astro (1)

10-22: ⚡ Quick win

Extract the tag-color system into a shared module/style.

The homepage and guide now each carry their own tagColor map plus near-identical color-* / accent-* rules. That already creates drift risk for the “unified” design system this PR introduces, because the next palette or tag change has to stay manually synchronized in both files. Move the mapping and color classes into one shared source and have both pages consume it.

Also applies to: 596-615

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@site/src/pages/index.astro` around lines 10 - 22, Extract the tag-color map
and duplicated color/accent CSS into a single shared module and stylesheet:
create a shared JS/TS export (e.g., export const tagColor:
Record<string,string>) containing the mapping currently defined as tagColor,
move the duplicated CSS rules (the color-* and accent-* classes) into one shared
CSS/SCSS file, then update both pages to import the shared tagColor module and
include the shared stylesheet instead of local copies; ensure symbol names
remain tagColor and the class names (color-*/accent-*) are unchanged so the
pages’ markup continues to work.
site/src/pages/guide/index.astro (1)

427-438: ⚡ Quick win

Allow guide card headers to wrap.

Unlike the homepage card header, this one has no wrap/shrink guard. Long names such as Jakarta JSON-B + JAXB can overflow against the badge on narrower widths.

Possible fix
   .card-header {
     display: flex;
     align-items: center;
     justify-content: space-between;
     gap: 0.5rem;
+    flex-wrap: wrap;
   }

   .card-name {
     font-size: 0.9rem;
     font-weight: 700;
     color: var(--color-primary);
+    min-width: 0;
   }
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@site/src/pages/guide/index.astro` around lines 427 - 438, The .card-header
currently allows the name to overflow the badge; update the CSS for .card-name
(used inside .card-header) to allow wrapping and let flex shrink it: add "flex:
1 1 auto; min-width: 0;" and enable wrapping/soft breaks (e.g. "overflow-wrap:
anywhere;" or "word-break: break-word;") so long names like "Jakarta JSON-B +
JAXB" wrap instead of overlapping the badge.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@site/src/pages/guide/index.astro`:
- Around line 192-195: Update the section heading text from “Contributing &
Maintainer” to “Contributing & Maintainers” by editing the h2 element with class
"section-heading" (the element that contains the span with class "section-icon"
and the emoji 🛠) so the visible title matches the plural form.

---

Nitpick comments:
In `@site/src/pages/guide/index.astro`:
- Around line 427-438: The .card-header currently allows the name to overflow
the badge; update the CSS for .card-name (used inside .card-header) to allow
wrapping and let flex shrink it: add "flex: 1 1 auto; min-width: 0;" and enable
wrapping/soft breaks (e.g. "overflow-wrap: anywhere;" or "word-break:
break-word;") so long names like "Jakarta JSON-B + JAXB" wrap instead of
overlapping the badge.

In `@site/src/pages/index.astro`:
- Around line 10-22: Extract the tag-color map and duplicated color/accent CSS
into a single shared module and stylesheet: create a shared JS/TS export (e.g.,
export const tagColor: Record<string,string>) containing the mapping currently
defined as tagColor, move the duplicated CSS rules (the color-* and accent-*
classes) into one shared CSS/SCSS file, then update both pages to import the
shared tagColor module and include the shared stylesheet instead of local
copies; ensure symbol names remain tagColor and the class names
(color-*/accent-*) are unchanged so the pages’ markup continues to work.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5afe114a-02fa-4314-8355-7ffbf195fdb6

📥 Commits

Reviewing files that changed from the base of the PR and between 0beacae and 6e73dec.

📒 Files selected for processing (3)
  • site/src/data/guide/introduction.mdx
  • site/src/pages/guide/index.astro
  • site/src/pages/index.astro

Comment thread site/src/pages/guide/index.astro
…overflow

  - Fix "Contributing & Maintainer" → "Contributing & Maintainers"
  - Add flex: 1 1 auto; min-width: 0; overflow-wrap: anywhere to .card-name
    to prevent long type names from overflowing the badge container
@domix domix merged commit d8d172b into main May 29, 2026
5 checks passed
@domix domix deleted the feature/docs/20260529 branch May 29, 2026 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

site Website and documentation site changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant