Skip to content

docs: add README for luna-reactlynx, update docs for related packages#86

Merged
Dugyu merged 1 commit intomainfrom
docs/luna-reactlynx
Apr 1, 2026
Merged

docs: add README for luna-reactlynx, update docs for related packages#86
Dugyu merged 1 commit intomainfrom
docs/luna-reactlynx

Conversation

@Dugyu
Copy link
Copy Markdown
Owner

@Dugyu Dugyu commented Apr 1, 2026

Summary by CodeRabbit

  • New Features

    • Prepare for the release of @dugyu/luna-reactlynx with ReactLynx theming integration.
  • Documentation

    • Added installation instructions across LUNA package READMEs.
    • Added a comprehensive ReactLynx README detailing theming usage, integration styles, and examples.
  • Chores

    • Made @dugyu/luna-reactlynx publicly publishable and updated package grouping/configuration.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 1, 2026

🦋 Changeset detected

Latest commit: 6ea79e9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages
Name Type
@dugyu/luna-tailwind Minor
@dugyu/luna-styles Minor
@dugyu/luna-tokens Minor
@dugyu/luna-core Minor
@dugyu/luna-reactlynx Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 1, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: d64d7f9c-ee35-4d31-938c-8cf9e97ff04e

📥 Commits

Reviewing files that changed from the base of the PR and between b66cfc5 and 6ea79e9.

📒 Files selected for processing (9)
  • .changeset/config.json
  • .changeset/few-places-repeat.md
  • .changeset/jolly-bottles-ask.md
  • packages/core/README.md
  • packages/reactlynx/README.md
  • packages/reactlynx/package.json
  • packages/styles/README.md
  • packages/tailwind/README.md
  • packages/tokens/README.md
✅ Files skipped from review due to trivial changes (9)
  • .changeset/jolly-bottles-ask.md
  • .changeset/few-places-repeat.md
  • .changeset/config.json
  • packages/styles/README.md
  • packages/core/README.md
  • packages/tokens/README.md
  • packages/tailwind/README.md
  • packages/reactlynx/package.json
  • packages/reactlynx/README.md

Walkthrough

Added a new public package @dugyu/luna-reactlynx (version 0.1.1) with accompanying changesets and updated README docs across core, styles, tailwind, and tokens; also appended the new package to the .changeset/config.json fixed group.

Changes

Cohort / File(s) Summary
Changeset files
\.changeset/config.json, \.changeset/few-places-repeat.md, \.changeset/jolly-bottles-ask.md
Appended @dugyu/luna-reactlynx to the fixed group and added changesets: patch entries for core/styles/tokens/tailwind and a minor (initial) release for reactlynx.
Reactlynx package metadata
packages/reactlynx/package.json
Published package metadata: version set to 0.1.1, removed private: true, updated homepage anchor, and added publishConfig: { "access": "public" }.
Reactlynx README
packages/reactlynx/README.md
New detailed README documenting theming integrations (JS Tokens & CSS Variables), provider/runtime usage, consumption formats, and entrypoints.
Cross-package READMEs
packages/core/README.md, packages/styles/README.md, packages/tailwind/README.md, packages/tokens/README.md
Added Installation sections and updated “LUNA Packages” lists to include @dugyu/luna-reactlynx and adjusted package role wording.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: adding a new README for luna-reactlynx and updating related package documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 docs/luna-reactlynx

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.

@Dugyu Dugyu changed the title docs: add README for luna-reactlynx, update README across luna packages docs: add README for luna-reactlynx, update docs for related packages Apr 1, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🧹 Nitpick comments (1)
packages/reactlynx/README.md (1)

91-95: Consolidate duplicated as: 'var-name' explanation.

Lines 92-95 repeat the same idea twice; trimming to one concise explanation will improve readability and reduce drift risk.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@packages/reactlynx/README.md` around lines 91 - 95, Remove the duplicated
explanation of the as: 'var-name' mode and replace both blocks with a single
concise sentence that states: "as: 'var-name' returns the bare CSS custom
property name (--xxx) rather than a complete CSS value, useful for building
expressions like var(--xxx, fallback) or calc(...)." Keep the surrounding
discussion of format and as: 'result' intact and ensure references to format and
as: 'var-name' remain correct.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.changeset/config.json:
- Around line 15-16: The package version for `@dugyu/luna-reactlynx` must be
bumped from 0.1.0 to 0.1.1 in its package.json to match `@dugyu/luna-core` (0.1.1)
so the fixed dependency group is consistent; after updating the
`@dugyu/luna-reactlynx` package version, update the corresponding changeset entry
(jolly-bottles-ask.md) so it reflects that reactlynx is joining the fixed group
at 0.1.1 rather than starting at 0.1.0.

In `@packages/reactlynx/package.json`:
- Line 3: Update the "version" field in package.json from "0.1.0" to "0.1.1" so
this package matches the fixed dependency group; locate the version entry in
packages/reactlynx/package.json (the "version" key) and change its value to
"0.1.1".

In `@packages/reactlynx/README.md`:
- Line 190: Replace the ambiguous heading text "Lynx 3.6- friendly" with the
explicit form "Lynx < 3.6 friendly" to match the style used elsewhere (e.g., the
heading at Line 161) so readers clearly understand the version constraint;
update every occurrence of the heading string in the README (including the
second instance noted) to the new "Lynx < 3.6 friendly" phrasing.
- Line 58: Guard the example's access to lynx.__globalProps by using optional
chaining so the themeKey expression won't throw when lynx or __globalProps is
undefined; update the themeKey usage (referencing the themeKey prop and
lynx.__globalProps) to read the lunaTheme via optional chaining (e.g.
lynx?.__globalProps?.lunaTheme) and fall back to 'lunaris-light'.

---

Nitpick comments:
In `@packages/reactlynx/README.md`:
- Around line 91-95: Remove the duplicated explanation of the as: 'var-name'
mode and replace both blocks with a single concise sentence that states: "as:
'var-name' returns the bare CSS custom property name (--xxx) rather than a
complete CSS value, useful for building expressions like var(--xxx, fallback) or
calc(...)." Keep the surrounding discussion of format and as: 'result' intact
and ensure references to format and as: 'var-name' remain correct.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 98c25628-3bda-49ef-8635-2be9422bd584

📥 Commits

Reviewing files that changed from the base of the PR and between 88a1788 and aa12ee1.

📒 Files selected for processing (9)
  • .changeset/config.json
  • .changeset/few-places-repeat.md
  • .changeset/jolly-bottles-ask.md
  • packages/core/README.md
  • packages/reactlynx/README.md
  • packages/reactlynx/package.json
  • packages/styles/README.md
  • packages/tailwind/README.md
  • packages/tokens/README.md

Comment thread .changeset/config.json
Comment thread packages/reactlynx/package.json Outdated
Comment thread packages/reactlynx/README.md
Comment thread packages/reactlynx/README.md Outdated
@Dugyu Dugyu force-pushed the docs/luna-reactlynx branch from aa12ee1 to b66cfc5 Compare April 1, 2026 11:49
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
packages/tailwind/README.md (1)

77-79: Clarify whether @dugyu/luna-reactlynx is required or optional in setup.

At Line 79, @dugyu/luna-reactlynx is listed as runtime integration, but Installation (Lines 9-12) doesn’t show when to install it. Add an “optional if using provider/hooks” install line (or explicitly state it is not required for Tailwind-only usage) to prevent onboarding confusion.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@packages/tailwind/README.md` around lines 77 - 79, Update the README to
clarify that `@dugyu/luna-reactlynx` is optional: in the Installation section add
a line like "Optional: install `@dugyu/luna-reactlynx` if you plan to use the
ReactLynx provider/hooks" or alternatively state explicitly that
`@dugyu/luna-reactlynx` is not required for Tailwind-only usage; reference the
package names `@dugyu/luna-tailwind` and `@dugyu/luna-reactlynx` so readers know
which package is optional and when to install it.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@packages/tailwind/README.md`:
- Around line 77-79: Update the README to clarify that `@dugyu/luna-reactlynx` is
optional: in the Installation section add a line like "Optional: install
`@dugyu/luna-reactlynx` if you plan to use the ReactLynx provider/hooks" or
alternatively state explicitly that `@dugyu/luna-reactlynx` is not required for
Tailwind-only usage; reference the package names `@dugyu/luna-tailwind` and
`@dugyu/luna-reactlynx` so readers know which package is optional and when to
install it.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b3dc45b6-56cb-4d7c-9e0a-f62b5c60f6fd

📥 Commits

Reviewing files that changed from the base of the PR and between aa12ee1 and b66cfc5.

📒 Files selected for processing (9)
  • .changeset/config.json
  • .changeset/few-places-repeat.md
  • .changeset/jolly-bottles-ask.md
  • packages/core/README.md
  • packages/reactlynx/README.md
  • packages/reactlynx/package.json
  • packages/styles/README.md
  • packages/tailwind/README.md
  • packages/tokens/README.md
✅ Files skipped from review due to trivial changes (7)
  • .changeset/jolly-bottles-ask.md
  • packages/core/README.md
  • .changeset/config.json
  • .changeset/few-places-repeat.md
  • packages/styles/README.md
  • packages/tokens/README.md
  • packages/reactlynx/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/reactlynx/package.json

@Dugyu Dugyu force-pushed the docs/luna-reactlynx branch from b66cfc5 to 6ea79e9 Compare April 1, 2026 11:54
@Dugyu Dugyu merged commit c47a909 into main Apr 1, 2026
7 checks passed
@Dugyu Dugyu deleted the docs/luna-reactlynx branch April 1, 2026 11:59
Dugyu pushed a commit that referenced this pull request Apr 1, 2026
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and publish to npm
yourself or [setup this action to publish
automatically](https://github.com/changesets/action#with-publishing). If
you're not ready to do a release yet, that's fine, whenever you add more
changesets to main, this PR will be updated.


# Releases
## @dugyu/luna-reactlynx@0.2.0

### Minor Changes

-   Initial release. ([#86](#86))

### Patch Changes

- Updated dependencies
\[[`c47a909`](c47a909)]:
    -   @dugyu/luna-core@0.2.0

## @dugyu/luna-core@0.2.0

### Patch Changes

-   Update README. ([#86](#86))

## @dugyu/luna-styles@0.2.0

### Patch Changes

-   Update README. ([#86](#86))

## @dugyu/luna-tailwind@0.2.0

### Patch Changes

-   Update README. ([#86](#86))

## @dugyu/luna-tokens@0.2.0

### Patch Changes

-   Update README. ([#86](#86))

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

1 participant