Update README #2676
Update README #2676
Conversation
|
Warning Rate limit exceeded@frzyc has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 5 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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 have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThe README.md file has been updated to rebrand the project from "Genshin Optimizer" to "Gacha Optimizer." This includes changes in titles, section headers, and links to reflect a broader focus on multiple gacha games. New sections for the Zenless Optimizer, including a dedicated roadmap and frontend details, have been added. The development server command has been revised to support the new Zenless frontend. Minor textual tweaks ensure clarity without altering core functionality. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant CLI as nx CLI
participant FE as Frontend Server
Dev->>CLI: Run "yarn run nx serve {frontend|sr-frontend|zzz-frontend}"
alt frontend selected
CLI->>FE: Launch Genshin Optimizer frontend
else sr-frontend selected
CLI->>FE: Launch secondary frontend service
else zzz-frontend selected
CLI->>FE: Launch Zenless Optimizer frontend
end
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
[sr-frontend] [Sat Feb 8 15:43:33 UTC 2025] - Deployed d22257f to https://genshin-optimizer-prs.github.io/pr/2676/sr-frontend (Takes 3-5 minutes after this completes to be available) [zzz-frontend] [Sat Feb 8 15:44:08 UTC 2025] - Deployed d22257f to https://genshin-optimizer-prs.github.io/pr/2676/zzz-frontend (Takes 3-5 minutes after this completes to be available) [frontend] [Sat Feb 8 15:45:30 UTC 2025] - Deployed d22257f to https://genshin-optimizer-prs.github.io/pr/2676/frontend (Takes 3-5 minutes after this completes to be available) [zzz-frontend] [Sat Feb 8 15:54:21 UTC 2025] - Deployed 170692e to https://genshin-optimizer-prs.github.io/pr/2676/zzz-frontend (Takes 3-5 minutes after this completes to be available) [sr-frontend] [Sat Feb 8 15:54:47 UTC 2025] - Deployed 170692e to https://genshin-optimizer-prs.github.io/pr/2676/sr-frontend (Takes 3-5 minutes after this completes to be available) [frontend] [Sat Feb 8 15:54:51 UTC 2025] - Deployed 170692e to https://genshin-optimizer-prs.github.io/pr/2676/frontend (Takes 3-5 minutes after this completes to be available) [sr-frontend] [Sat Feb 8 16:03:27 UTC 2025] - Deployed eba9c90 to https://genshin-optimizer-prs.github.io/pr/2676/sr-frontend (Takes 3-5 minutes after this completes to be available) [frontend] [Sat Feb 8 16:03:34 UTC 2025] - Deployed eba9c90 to https://genshin-optimizer-prs.github.io/pr/2676/frontend (Takes 3-5 minutes after this completes to be available) [zzz-frontend] [Sat Feb 8 16:03:42 UTC 2025] - Deployed eba9c90 to https://genshin-optimizer-prs.github.io/pr/2676/zzz-frontend (Takes 3-5 minutes after this completes to be available) [Sat Feb 8 16:19:33 UTC 2025] - Deleted deployment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 14
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
README.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~13-~13: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e providing a clean, structured UI, and provide real-time results. [Zenless Optimizer]...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~108-~108: You might be missing the article “the” here.
Context: ...ers and values from the datamine, using Optimizer pipeline. [zzz-stats](/libs/zzz/stats/...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~110-~110: You might be missing the article “the” here.
Context: ...m the datamine Hakush.in API, using Optimizer pipeline. ## Basic Setup Install `yar...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
README.md
3-3: Inline HTML
Element: a
(MD033, no-inline-html)
3-3: Inline HTML
Element: img
(MD033, no-inline-html)
5-5: Inline HTML
Element: a
(MD033, no-inline-html)
5-5: Inline HTML
Element: img
(MD033, no-inline-html)
6-6: Inline HTML
Element: a
(MD033, no-inline-html)
6-6: Inline HTML
Element: img
(MD033, no-inline-html)
7-7: Inline HTML
Element: a
(MD033, no-inline-html)
7-7: Inline HTML
Element: img
(MD033, no-inline-html)
8-8: Inline HTML
Element: a
(MD033, no-inline-html)
8-8: Inline HTML
Element: img
(MD033, no-inline-html)
9-9: Inline HTML
Element: a
(MD033, no-inline-html)
9-9: Inline HTML
Element: img
(MD033, no-inline-html)
31-31: Bare URL used
null
(MD034, no-bare-urls)
38-38: Bare URL used
null
(MD034, no-bare-urls)
120-120: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: test
- GitHub Check: typecheck
- GitHub Check: lint
- GitHub Check: gen-file
- GitHub Check: call-build / build
- GitHub Check: call-build / build
- GitHub Check: call-build / build
- GitHub Check: call-build / build
- GitHub Check: call-build / build
🔇 Additional comments (10)
README.md (10)
1-1: Branding Title Update
Line 1 updates the title to “Gacha Optimizer”, which is spot on for the rebranding. My bleary eyes approve of this fresh start.
3-5: Badge Links & Inline HTML Usage
The inline HTML for badges on lines 3 and 5 is common in READMEs—even if markdownlint grumbles about MD033. Just be sure these links align with your rebranding goals. My caffeine-deprived self finds this acceptable.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Inline HTML
Element: a(MD033, no-inline-html)
3-3: Inline HTML
Element: img(MD033, no-inline-html)
5-5: Inline HTML
Element: a(MD033, no-inline-html)
5-5: Inline HTML
Element: img(MD033, no-inline-html)
11-11: Project Description Clarity
Line 11 now explicitly states that the repo hosts several optimizer websites for different gacha games. This inclusive language is much appreciated when running on sleep fumes.
27-27: Roadmap Heading Rebrand
Line 27’s “Gacha Optimizer Roadmap” heading looks great and aligns perfectly with the new branding. It’s a bright spot in this pre-dawn code review.
29-29: Timestamp Update Check
“Last updated Feb 2025” on line 29 confirms everything is timely—even if I’m running on a few hours of sleep. No issues here!
40-40: Strikethrough Roadmap Item Clarity
Line 40 appropriately strikes through the old “(bare-bones) Optimizer for Zenless Zone Zero” milestone. This makes the deprecation clear and saves you from future confusion—even if my brain is already half-asleep from too many deadlines.
42-42: Team/Combo System Roadmap Addition
Line 42’s addition of the team/combo system is clearly noted as TBD. This enhancement fits naturally into the roadmap and my overworked mind approves.
45-45: Star Rail Section Header
Line 45’s “SRO - GO but Star Rail” is a quirky and catchy header. Just ensure it’s clear for new contributors what this section entails.
67-67: Timeline Update on GO-next Roadmap
Line 67 shows that the “Coming Q4 2024” item is now struck through and replaced with “On Hiatus”. This update communicates the current status well and avoids false expectations.
82-82: Zenless Frontend Entry Added
Line 82 neatly introduces the Zenless Optimizer frontend entry. This addition rounds out the updated project scope nicely—even if my eyes are about to bolt for another cup of coffee.
| [Genshin Optimizer](https://frzyc.github.io/genshin-optimizer) is a helper website for the online action-rpg gacha game [Genshin Impact](https://genshin.mihoyo.com/). It is intended to assist players with optimizing artifacts to max-min their characters, while providing a clean, structured UI, and provide real-time results. | ||
| A repo hosting a few different optimizer websites for different gacha games. | ||
|
|
||
| [Genshin Optimizer](https://frzyc.github.io/genshin-optimizer) is a helper website for the online action-rpg gacha game [Genshin Impact](https://genshin.hoyoverse.com/). It is intended to assist players with optimizing artifacts to max-min their characters, while providing a clean, structured UI, and provide real-time results. |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Phrasing Consistency Suggestion
The description on line 13 reads “…providing a clean, structured UI, and provide real-time results.” Consider revising it to “…providing a clean, structured UI, and provides real-time results” to ensure subject–verb agreement. Also, double-check “max-min their characters” for clarity.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...e providing a clean, structured UI, and provide real-time results. [Zenless Optimizer]...
(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
README.md
Outdated
| @@ -90,15 +117,15 @@ Run `yarn` to install dependencies. | |||
|
|
|||
| ## Development server | |||
|
|
|||
| Run `yarn run nx serve {frontend | sr-frontend}` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files. | |||
| Run `yarn run nx serve {frontend | sr-frontend | zzz-frontend}` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files. | |||
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Bare URL in Dev Server Command
Line 120 contains a bare URL (“http://localhost:4200/”) which might trigger markdownlint MD034. Consider wrapping it in a markdown link or in angle brackets to tidy things up.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
120-120: Bare URL used
null
(MD034, no-bare-urls)
There was a problem hiding this comment.
Actionable comments posted: 8
♻️ Duplicate comments (1)
README.md (1)
43-43: 🧹 Nitpick (assertive)Terminology Clarification Needed:
The phrase “Complete addition of characters/discs/wengines to the system” might not be immediately clear to new users. It may help to elaborate or link to definitions for “discs” and “wengines.”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
3-3: Inline HTML
Element: a
(MD033, no-inline-html)
3-3: Inline HTML
Element: img
(MD033, no-inline-html)
5-5: Inline HTML
Element: a
(MD033, no-inline-html)
5-5: Inline HTML
Element: img
(MD033, no-inline-html)
6-6: Inline HTML
Element: a
(MD033, no-inline-html)
6-6: Inline HTML
Element: img
(MD033, no-inline-html)
7-7: Inline HTML
Element: a
(MD033, no-inline-html)
7-7: Inline HTML
Element: img
(MD033, no-inline-html)
8-8: Inline HTML
Element: a
(MD033, no-inline-html)
8-8: Inline HTML
Element: img
(MD033, no-inline-html)
9-9: Inline HTML
Element: a
(MD033, no-inline-html)
9-9: Inline HTML
Element: img
(MD033, no-inline-html)
120-120: Bare URL used
null
(MD034, no-bare-urls)
🪛 LanguageTool
README.md
[uncategorized] ~86-~86: The official spelling of this programming framework is “Next.js”.
Context: ...- WIP GO frontend - website built using NextJS, MUI, supabase, using the Pando calcula...
(NODE_JS)
[uncategorized] ~108-~108: You might be missing the article “the” here.
Context: ...ers and values from the datamine, using Optimizer pipeline. [zzz-stats](/libs/zzz/stats/...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~110-~110: You might be missing the article “the” here.
Context: ...m the datamine Hakush.in API, using Optimizer pipeline. ## Basic Setup Install `yar...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: test
- GitHub Check: lint
- GitHub Check: call-build / build
🔇 Additional comments (17)
README.md (17)
1-1: Title Rebranding Update:
The title has been updated to “# Gacha Optimizer,” which nicely reflects the broader project focus.
3-4: Genshin Optimizer Shield Link:
The shield image linking to the Genshin Optimizer site is still present. Please verify that retaining this identity under the new “Gacha Optimizer” umbrella is intentional.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Inline HTML
Element: a(MD033, no-inline-html)
3-3: Inline HTML
Element: img(MD033, no-inline-html)
5-5: Zenless Optimizer Shield Addition:
Good to see the new Zenless Optimizer shield link added. It clearly distinguishes this new component of the project.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Inline HTML
Element: a(MD033, no-inline-html)
5-5: Inline HTML
Element: img(MD033, no-inline-html)
13-13: Grammar Consistency in Description:
In the Genshin Optimizer description, “and provide real-time results” should be “and provides real-time results” for proper subject–verb agreement.
15-15: Clarification on “Basic Disc Optimization”:
The phrase “basic disc optimization” may be ambiguous. Consider clarifying what “disc” specifically refers to (or rewording it) unless it’s already clear within your team.
27-29: Roadmap Section Update:
The new “Gacha Optimizer Roadmap” section—with “Last updated Feb 2025”—is clear and up to date.
41-41: Pando Engine Entry Confirmation:
The entry “Pando (New calculation engine) TBD” is clear. Just double-check that its capitalization and style remain consistent with similar entries elsewhere in the document.
45-45: Title Review – SRO Section:
“### SRO - GO but Star Rail” is catchy but could be confusing at a glance. Please verify that this phrasing accurately conveys the intended section meaning.
63-63: GO-next Calculation Engine Update:
The entry “New calculation engine - Pando” is consistent with the other feature listings.
68-68: Status Update Clarity:
Marking the feature as “Coming Q4 2024On Hiatus” clearly communicates its status.
73-73: Applications Link Update:
“Applications are in /apps” is both concise and clear.
74-74: Dependencies Location:
“Dependencies for the apps can be found in /libs.” is straightforward and easy to locate.
76-76: Interactive Graph Command:
The instruction “For a more interactive and detailed view of the project, runnx graph.” is a useful addition.
80-80: Frontend Description Clarity:
The descriptor for [frontend] clearly notes that it uses the now deprecated Waverider calculation engine. Great detail here.
82-82: Zenless Optimizer Frontend:
The description for [zzz-frontend] is clear and aligns well with the rebranding efforts.
96-96: Genshin WR Engine Entry:
The [gi-wr] entry is concise and maintains consistent formatting with other items.
104-104: Zenless Formula Entry:
The [zzz-formula] entry accurately describes the Zenless implementation of Pando and is well formatted.
Describe your changes
Issue or discord link
Testing/validation
Checklist before requesting a review (leave this PR as draft if any part of this list is not done.)
yarn run mini-cilocally to validate format and lint.Summary by CodeRabbit
Documentation
New Features