Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThis PR updates documentation across the repo: removes beta/requirements notices, restructures installation and overview content, deletes “Initial Set-Up” and “Release Schedule” pages and sidebar links, overhauls the upgrading guide for 1.x (docs-only), adjusts security and contributing docs, adds a support exclusion, and reflows README text. No code changes. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
docs/core/installation.md (1)
51-59: Code block likely broken: missing closing braces and fenceThe AppServiceProvider example doesn’t close the method/class, and the code fence appears unclosed. This will render incorrectly and could confuse readers.
Apply the following fix to close the method, the class, and the code fence:
use Lunar\Admin\Support\Facades\LunarPanel; class AppServiceProvider extends ServiceProvider { public function register(): void { LunarPanel::register(); } -} +} +} - +```
🧹 Nitpick comments (19)
docs/support.md (1)
43-43: Tighten phrasing for clarity and tone consistency“snippets of code” is fine, but the latter clause reads more cleanly without a contraction and aligns with the surrounding formal tone.
Apply this diff:
- - 🚫 Full codebase reviews – We can review snippets of code, but not an entire application. + - 🚫 Full codebase reviews – We can review code snippets, but cannot review an entire application.docs/admin/overview.md (2)
3-3: Consider linking to Filament v3 docsAdding a link helps readers jump straight to the relevant framework.
-Lunar's admin panel is powered by **Filament v3**. It allows you to easily extend the admin panel to suit your project. +Lunar's admin panel is powered by **[Filament v3](https://filamentphp.com/docs/3.x)**. It allows you to easily extend the admin panel to suit your project.
14-20: Verify the code sample has a closing class braceThe example appears to be missing the class’ closing brace. Adding it avoids copy/paste errors for readers.
class AppServiceProvider extends ServiceProvider { public function register(): void { LunarPanel::register(); } +}packages/core/README.md (1)
5-6: Fix possessive “its” and hyphenation; align style with the projectSmall grammar/style pass to improve clarity and consistency (“its” vs “it’s”, “open‑source”, “e‑commerce”, and “feature‑rich”).
-Lunar is an open source E-commerce platform which embraces Laravel as it's foundation and uses it to build a highly -extensible, robust and feature rich application you can build any store on. +Lunar is an open-source e-commerce platform that embraces Laravel as its foundation and uses it to build a highly +extensible, robust, and feature-rich application you can build any store on.docs/core/overview.md (3)
14-16: Use a colon and add commas for readability; optionally link to FilamentMinor punctuation improves readability. Adding a link is optional but helpful.
-Lunar is comprised of two packages; `lunarphp/core` which provides the e-commerce functionality and `lunarphp/lunar` -which provides an admin panel built on Filament. +Lunar is comprised of two packages: `lunarphp/core`, which provides the e-commerce functionality, and `lunarphp/lunar`, +which provides an admin panel built on [Filament](https://filamentphp.com/docs/3.x).
17-19: Clarify Livewire mention with a linkSince Filament uses Livewire, linking Livewire helps readers who aren’t familiar with it.
-:::info -Although the admin panel uses Laravel Livewire, there is no requirement for your app to use Livewire itself. -::: +:::info +Although the admin panel uses [Laravel Livewire](https://livewire.laravel.com/), there is no requirement for your app to use Livewire itself. +:::
23-24: Tone: replace “awesome” with a more neutral alternativeKeeps the docs’ tone professional.
-Lunar as a company has grand plans to continue developing new functionality to help you build awesome e-commerce +Lunar as a company has grand plans to continue developing new functionality to help you build high-quality e-commerce websites. We want Lunar to be a true alternative to the likes of Magento, Shopify, WooCommerce, etc.docs/core/installation.md (2)
79-81: Fix comma splices and tighten wording in Telemetry paragraphCurrent sentence has two comma splices and reads a bit heavy. Recommend splitting into shorter sentences.
-Lunar will phone home to send anonymous usage insights, the data we capture does not identify your store in any way, it -exists to help us gain an understanding of how Lunar is used. You can easily opt out of this by adding the following to -your service provider's boot method: +Lunar will phone home to send anonymous usage insights. The data we capture does not identify your store in any way. +This exists to help us understand how Lunar is used. You can opt out by adding the following to +your service provider's boot method:
89-94: Minor consistency nit: “User ID” type guidanceThis guidance is helpful. Consider linking directly to the config file path in the Monorepo for quick reference if feasible (optional).
docs/core/contributing.md (6)
7-8: Reduce wordiness and improve phrasingTighten the sentence and avoid “make” + noun.
-You can contribute to the project in many different ways. Reporting bugs, fixing bugs, helping with the documentation, -making suggestions and submitting improvements to the software. +You can contribute in many ways: reporting bugs, fixing bugs, helping with the documentation, +suggesting enhancements, and submitting improvements to the software.
25-31: Pluralization and hyphenation fixes
- “monorepo's” should be “monorepos” (plural, not possessive).
- “set-up” (as a verb) should be “set up”.
-However, if you're not used to working with monorepo's and setting them up inside a test Laravel application, no problem! +However, if you're not used to working with monorepos and setting them up inside a test Laravel application, no problem! ::: tip -Here's a guide on how to set-up your development environment ready for contributing to Lunar. +Here's a guide on how to set up your development environment, ready for contributing to Lunar.
51-57: Hyphenate “Open‑source” in compound adjective usage-Open source code belongs to all of us, and it's all of our responsibility to push it forward. +Open-source code belongs to all of us, and it's all of our responsibility to push it forward.
60-63: Tone and clarity: replace “awesome”, clarify expectation-Before you start coding away on the next awesome feature, we highly recommend starting a +Before you start building the next feature, we highly recommend starting a [discussion](https://github.com/lunarphp/lunar/discussions) to check that your contribution will be welcomed. We would -hate for you to spend valuable time on something that won't be merged into Lunar. +hate for you to spend valuable time on something that won't be merged.
73-81: Tighten PR checklist lead-in and modernize test phrasing-A PR should be able to include the following: +A PR should include the following: @@ -- Automated tests with adequate code coverage +- Automated tests with adequate coverage
84-85: Improve flow-If you would like to contribute to the documentation you can do easily by following these instructions... +If you’d like to contribute to the documentation, you can do so easily by following these instructions:docs/core/upgrading.md (4)
282-284: Grammar: singular/plural agreement and article usage-Collection Group now have unique index on the column `handle`. -If you are creating Collection Group from the admin panel, there is no changes required. +Collection groups now have a unique index on the `handle` column. +If you are creating collection groups from the admin panel, there are no changes required.
362-364: Grammar: “upgrade” → “upgraded”-This package has been upgrade to version 11, which introduces some breaking changes. +This package has been upgraded to version 11, which introduces some breaking changes.
365-369: Typo and clarity in “Media Conversions”Fixes “definitionss” and slightly tightens the wording.
-The `lunar.media.conversions` configuration has been removed, in favour of registering custom media definitionss instead. -Media definition classes allow you to register media collections, conversions and much more. See [Media Collections](/core/reference/media.html#media-collections) +The `lunar.media.conversions` configuration has been removed in favour of registering custom media definitions instead. +Media definition classes allow you to register media collections, conversions, and more. See [Media Collections](/core/reference/media.html#media-collections) for further information.
371-377: Consistency: clarify renaming languageOptional, but you may want to explicitly say “rename references from ‘tiers’ to ‘priceBreaks’” for quicker scanning. If you prefer to keep the current style, ignore.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (12)
README.md(0 hunks)docs/.vitepress/config.js(0 hunks)docs/admin/overview.md(1 hunks)docs/core/contributing.md(5 hunks)docs/core/installation.md(2 hunks)docs/core/overview.md(1 hunks)docs/core/release-schedule.md(0 hunks)docs/core/securing-your-site.md(1 hunks)docs/core/set-up.md(0 hunks)docs/core/upgrading.md(2 hunks)docs/support.md(1 hunks)packages/core/README.md(1 hunks)
💤 Files with no reviewable changes (4)
- docs/core/set-up.md
- docs/.vitepress/config.js
- README.md
- docs/core/release-schedule.md
🧰 Additional context used
🪛 LanguageTool
docs/support.md
[grammar] ~43-~43: There might be a mistake here.
Context: ... you, but we won’t write custom code. - 🚫 Full codebase reviews – We can review ...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ... write custom code. - 🚫 Full codebase reviews – We can review snippets of code, but not an ...
(QB_NEW_EN)
docs/core/installation.md
[grammar] ~79-~79: There might be a mistake here.
Context: ...s not identify your store in any way, it exists to help us gain an understanding ...
(QB_NEW_EN)
[grammar] ~80-~80: There might be a mistake here.
Context: ...t out of this by adding the following to your service provider's boot method: ``...
(QB_NEW_EN)
docs/core/overview.md
[style] ~21-~21: ‘future plans’ might be wordy. Consider a shorter alternative.
Context: ...e Livewire itself. ::: ## What are the future plans? Lunar as a company has grand plans to...
(EN_WORDINESS_PREMIUM_FUTURE_PLANS)
[style] ~23-~23: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ing new functionality to help you build awesome e-commerce websites. We want Lunar to ...
(AWESOME)
docs/core/contributing.md
[style] ~7-~7: ‘many different ways’ might be wordy. Consider a shorter alternative.
Context: .... You can contribute to the project in many different ways. Reporting bugs, fixing bugs, helping w...
(EN_WORDINESS_PREMIUM_MANY_DIFFERENT_WAYS)
[style] ~7-~7: “Make” is an overused word. Consider a different verb to strengthen your wording.
Context: ... bugs, helping with the documentation, making suggestions and submitting improvements...
(MAKE_A_SUGGESTION)
[grammar] ~51-~51: There might be a mistake here.
Context: ... to get the attention it needs. :::info Be aware that creating an issue does not...
(QB_NEW_EN)
[uncategorized] ~54-~54: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...t to look into it as soon as possible. Open source code belongs to all of us, and it's all...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~60-~60: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...efore you start coding away on the next awesome feature, we highly recommend starting a...
(AWESOME)
[grammar] ~69-~69: There might be a mistake here.
Context: ...ture can be reviewed in a timely manner. If the pull request is missing informati...
(QB_NEW_EN)
docs/core/upgrading.md
[grammar] ~350-~350: There might be a mistake here.
Context: ...\Stripe; ``` ## 1.0.0-alpha :::warning If upgrading from 0.x please ensure yo...
(QB_NEW_EN)
[grammar] ~351-~351: There might be a mistake here.
Context: ... are on 0.8 before upgrading to 1.x. ::: ### High Impact #### Change to Sta...
(QB_NEW_EN)
⏰ 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). (20)
- GitHub Check: search - PHP 8.4 - L12.* ↑
- GitHub Check: stripe - PHP 8.4 - L12.* ↑
- GitHub Check: admin - PHP 8.4 - L12.* ↑
- GitHub Check: stripe - PHP 8.4 - L12.* ↑ E
- GitHub Check: core - PHP 8.4 - L12.* ↑ E
- GitHub Check: shipping - PHP 8.4 - L12.* ↑
- GitHub Check: core - PHP 8.4 - L11.* ↑ E
- GitHub Check: admin - PHP 8.3 - L11.* ↑
- GitHub Check: shipping - PHP 8.4 - L11.* ↑
- GitHub Check: search - PHP 8.3 - L12.* ↑
- GitHub Check: admin - PHP 8.4 - L11.* ↑ E
- GitHub Check: core - PHP 8.4 - L11.* ↑
- GitHub Check: stripe - PHP 8.3 - L11.* ↑ E
- GitHub Check: admin - PHP 8.3 - L11.* ↑ E
- GitHub Check: admin - PHP 8.3 - L12.* ↑
- GitHub Check: core - PHP 8.3 - L11.* ↑ E
- GitHub Check: core - PHP 8.3 - L12.* ↑
- GitHub Check: core - PHP 8.3 - L12.* ↑ E
- GitHub Check: core - PHP 8.3 - L11.* ↑
- GitHub Check: fix-code-style
🔇 Additional comments (5)
docs/core/securing-your-site.md (1)
50-50: LGTM: link normalizationTrailing slash addition looks good and matches Algolia’s canonical docs URL.
docs/core/installation.md (2)
18-19: Composer constraint update to ^1.0 looks correctGood alignment with the v1.0.0 stable release messaging elsewhere in the docs.
75-86: Good restructure: “Advanced Installation Options” + Telemetry placementMoving Telemetry under Advanced options improves discoverability without overwhelming the core installation flow.
docs/core/upgrading.md (2)
21-29: Scout toggle guidance is clear and actionableGood, concise explanation and example config override.
34-43: Telemetry opt‑out note reads well and matches installation guidanceConsistent with the installation page’s Telemetry section.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (8)
docs/core/contributing.md (8)
7-8: Tighten wording and fix sentence fragment.Second sentence is a fragment; also “many different ways” is wordy and “making suggestions” is weak. Suggest a concise, single sentence.
Apply this diff:
-You can contribute to the project in many different ways. Reporting bugs, fixing bugs, helping with the documentation, -making suggestions and submitting improvements to the software. +You can contribute in many ways, including reporting and fixing bugs, improving the documentation, +proposing ideas, and submitting enhancements to the software.
25-25: Pluralization: “monorepo's” → “monorepos”.Apostrophe indicates possession, not plural.
-However, if you're not used to working with monorepo's and setting them up inside a test Laravel application, no problem! +However, if you're not used to working with monorepos and setting them up inside a test Laravel application, no problem!
34-36: Polish phrasing and casing (“GitHub issue”), add comma after introductory clause.-If you find a bug in the software please raise a GitHub Issue on the -[lunarphp/lunar](https://github.com/lunarphp/lunar/issues) repository. Please ensure that your issue includes the -following: +If you find a bug in the software, please open a GitHub issue on the +[lunarphp/lunar](https://github.com/lunarphp/lunar/issues) repository. Please ensure your report includes the +following:
45-45: Consistent style: lowercase “pull request” and align list punctuation.Elsewhere you use lowercase “pull request” and list items don’t end with periods.
-- An accompanying Pull Request with a test to demonstrate the issue. +- An accompanying pull request with a test to demonstrate the issue
60-63: Tone: replace “awesome feature” with neutral wording.-Before you start coding away on the next awesome feature, we highly recommend starting a +Before you start coding a new feature, we highly recommend starting a [discussion](https://github.com/lunarphp/lunar/discussions) to check that your contribution will be welcomed. We would hate for you to spend valuable time on something that won't be merged into Lunar.
74-79: Use “briefly” instead of “quickly” for clarity.Minor wording improvement; keeps the meaning while reading more naturally in guidelines.
-- The title should be relevant and quickly explain what to expect inside +- The title should be relevant and briefly explain what to expect inside
83-83: Grammar: “do so easily”.-If you would like to contribute to the documentation you can do easily by following these instructions... +If you would like to contribute to the documentation you can do so easily by following these instructions...
87-87: Smoother instruction phrasing.-3. In your terminal change to the `/docs` directory +3. Change to the `/docs` directory
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/core/contributing.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/core/contributing.md
[style] ~7-~7: ‘many different ways’ might be wordy. Consider a shorter alternative.
Context: .... You can contribute to the project in many different ways. Reporting bugs, fixing bugs, helping w...
(EN_WORDINESS_PREMIUM_MANY_DIFFERENT_WAYS)
[style] ~7-~7: “Make” is an overused word. Consider a different verb to strengthen your wording.
Context: ... bugs, helping with the documentation, making suggestions and submitting improvements...
(MAKE_A_SUGGESTION)
[grammar] ~51-~51: There might be a mistake here.
Context: ... to get the attention it needs. :::info Be aware that creating an issue does not...
(QB_NEW_EN)
[uncategorized] ~54-~54: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...t to look into it as soon as possible. Open source code belongs to all of us, and it's all...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~60-~60: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...efore you start coding away on the next awesome feature, we highly recommend starting a...
(AWESOME)
[grammar] ~69-~69: There might be a mistake here.
Context: ...ture can be reviewed in a timely manner. If the pull request is missing informati...
(QB_NEW_EN)
[style] ~74-~74: Consider using the synonym “briefly” (= concisely, using a few words) to strengthen your wording.
Context: ...ng: - The title should be relevant and quickly explain what to expect inside - A clear...
(QUICKLY_BRIEFLY)
⏰ 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). (20)
- GitHub Check: search - PHP 8.4 - L12.* ↑ E
- GitHub Check: shipping - PHP 8.4 - L12.* ↑
- GitHub Check: shipping - PHP 8.4 - L11.* ↑
- GitHub Check: shipping - PHP 8.4 - L11.* ↑ E
- GitHub Check: search - PHP 8.3 - L12.* ↑ E
- GitHub Check: admin - PHP 8.4 - L11.* ↑ E
- GitHub Check: search - PHP 8.4 - L11.* ↑ E
- GitHub Check: core - PHP 8.4 - L11.* ↑ E
- GitHub Check: stripe - PHP 8.3 - L12.* ↑
- GitHub Check: admin - PHP 8.4 - L11.* ↑
- GitHub Check: core - PHP 8.4 - L11.* ↑
- GitHub Check: core - PHP 8.3 - L12.* ↑
- GitHub Check: admin - PHP 8.3 - L12.* ↑
- GitHub Check: core - PHP 8.3 - L12.* ↑ E
- GitHub Check: admin - PHP 8.3 - L12.* ↑ E
- GitHub Check: admin - PHP 8.3 - L11.* ↑ E
- GitHub Check: admin - PHP 8.3 - L11.* ↑
- GitHub Check: core - PHP 8.3 - L11.* ↑ E
- GitHub Check: core - PHP 8.3 - L11.* ↑
- GitHub Check: fix-code-style
🔇 Additional comments (2)
docs/core/contributing.md (2)
68-71: Thanks for addressing the earlier grammar issue here.The revised sentence (“it could delay progress or be closed.”) reads correctly now.
27-30: Admonition usage LGTM.The “tip” block and link to local development setup are clear and helpful.
Updates documentation for v1.0.0 release
Summary by CodeRabbit