Skip to content

ZO: Add a roadmap to home page#2725

Merged
frzyc merged 1 commit into
masterfrom
zo_roadmap
Feb 12, 2025
Merged

ZO: Add a roadmap to home page#2725
frzyc merged 1 commit into
masterfrom
zo_roadmap

Conversation

@frzyc

@frzyc frzyc commented Feb 12, 2025

Copy link
Copy Markdown
Owner

Describe your changes

Issue or discord link

Testing/validation

screencapture-localhost-4200-2025-02-12-15_56_41

Checklist before requesting a review (leave this PR as draft if any part of this list is not done.)

  • I have commented my code in hard-to understand areas.
  • I have made corresponding changes to README or wiki.
  • For front-end changes, I have updated the corresponding English translations.
  • I have run yarn run mini-ci locally to validate format and lint.
  • If I have added a new library or app, I have updated the deployment scripts to ignore changes as needed

Summary by CodeRabbit

  • New Features
    • Introduced an interactive roadmap view that displays project milestones, progress indicators, and associated tasks.
    • Updated the homepage layout to prominently feature the new roadmap alongside an enhanced release notes section.

@coderabbitai

coderabbitai Bot commented Feb 12, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The pull request expands the GitHub Actions workflows to include steps that create a .env.local file for the new zzz-frontend application. It also renames an environment variable in apps/zzz-frontend/.env and introduces a new React component, Roadmap, in libs/zzz/page-home/src/Roadmap.tsx. The PageHome component in libs/zzz/page-home/src/index.tsx is updated to incorporate Roadmap, revise the layout using a Stack and a new ZCard for patch notes, and adjust the API URL.

Changes

File(s) Change Summary
.github/workflows/build-frontend.yml, .github/workflows/build-new-release.yml Added new steps to create .env.local for zzz-frontend alongside the existing setup.
apps/zzz-frontend/.env Renamed environment variable from NX_URL_GITHUB_API_ZZZ_RELEASES to NX_URL_GITHUB_API_GO_RELEASES.
libs/zzz/page-home/src/Roadmap.tsx, libs/zzz/page-home/src/index.tsx Introduced new Roadmap component; updated PageHome with a revised layout (using Stack and ZCard) and updated fetch URL.

Sequence Diagram(s)

sequenceDiagram
    participant CI as GitHub Actions
    participant Build as Build Process
    participant FE as Frontend Setup
    CI->>Build: Trigger build workflow for frontend
    Build->>FE: Execute setup for .env.local (existing & new for zzz-frontend)
    FE-->>Build: Environment files created
    Build-->>CI: Build process completes
Loading
sequenceDiagram
    participant UI as PageHome Component
    participant RM as Roadmap Component
    participant ZC as ZCard (PatchNotesCard)
    UI->>RM: Render Roadmap component
    UI->>ZC: Render PatchNotesCard with updated API URL
    RM-->>UI: Display roadmap milestones
    ZC-->>UI: Display patch notes
Loading

Possibly related PRs

Suggested labels

ZO, CI

Poem

In the quiet hum of CI’s night,
New .env files spring to light.
Code assembles with a tired glow,
As Roadmap dreams and patches flow.
Caffeine fuels our midnight plight—
Insomniac code sings on into the night! ☕🌙


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?

❤️ Share
🪧 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. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@github-actions

github-actions Bot commented Feb 12, 2025

Copy link
Copy Markdown
Contributor

[sr-frontend] [Wed Feb 12 21:03:24 UTC 2025] - Deployed d31ba01 to https://genshin-optimizer-prs.github.io/pr/2725/sr-frontend (Takes 3-5 minutes after this completes to be available)

[frontend] [Wed Feb 12 21:03:44 UTC 2025] - Deployed d31ba01 to https://genshin-optimizer-prs.github.io/pr/2725/frontend (Takes 3-5 minutes after this completes to be available)

[zzz-frontend] [Wed Feb 12 21:04:18 UTC 2025] - Deployed d31ba01 to https://genshin-optimizer-prs.github.io/pr/2725/zzz-frontend (Takes 3-5 minutes after this completes to be available)

[sr-frontend] [Wed Feb 12 22:04:38 UTC 2025] - Deployed d31ba01 to https://genshin-optimizer-prs.github.io/pr/2725/sr-frontend (Takes 3-5 minutes after this completes to be available)

[zzz-frontend] [Wed Feb 12 22:04:46 UTC 2025] - Deployed d31ba01 to https://genshin-optimizer-prs.github.io/pr/2725/zzz-frontend (Takes 3-5 minutes after this completes to be available)

[frontend] [Wed Feb 12 22:05:14 UTC 2025] - Deployed d31ba01 to https://genshin-optimizer-prs.github.io/pr/2725/frontend (Takes 3-5 minutes after this completes to be available)

[Wed Feb 12 22:30:59 UTC 2025] - Deleted deployment

@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: 0

🧹 Nitpick comments (1)
libs/zzz/page-home/src/Roadmap.tsx (1)

12-180: Accessibility is on point! But we need i18n... sips more coffee

Love the aria-labels for emojis and the structured hierarchy! However, all the text is hardcoded in English. We should move these strings to translation files.

Let's wrap the text content with translation components. Here's an example for the first milestone:

-          Roadmap to ZZZero-maxxing
+          {t('roadmap.title')}

Also, consider extracting milestone data to a separate configuration file for better maintainability:

// roadmap.config.ts
export const milestones = [
  {
    id: 1,
    titleKey: 'roadmap.milestone1.title',
    status: 'completed',
    descriptionKey: 'roadmap.milestone1.description',
    tasks: [
      { key: 'roadmap.milestone1.tasks.datamine' },
      // ... more tasks
    ]
  },
  // ... more milestones
];
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c25af72 and 3cbee63.

📒 Files selected for processing (5)
  • .github/workflows/build-frontend.yml (1 hunks)
  • .github/workflows/build-new-release.yml (1 hunks)
  • apps/zzz-frontend/.env (1 hunks)
  • libs/zzz/page-home/src/Roadmap.tsx (1 hunks)
  • libs/zzz/page-home/src/index.tsx (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • apps/zzz-frontend/.env
🔇 Additional comments (4)
libs/zzz/page-home/src/index.tsx (2)

14-19: Layout structure looks clean! yawns

The Stack component with consistent spacing creates a nice vertical rhythm. The ZCard wrapper adds a nice touch of consistency with the design system.


29-29: Hold up... environment variable name changed! ☕️

The API URL environment variable has changed from NX_URL_GITHUB_API_ZZZ_RELEASES to NX_URL_GITHUB_API_GO_RELEASES. Let's make sure this is updated everywhere.

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Check for any remaining references to the old env var
rg "NX_URL_GITHUB_API_ZZZ_RELEASES"

Length of output: 35


Verified: Environment variable update is complete with no lingering references to the old variable.

  • Confirmed the usage in libs/zzz/page-home/src/index.tsx now correctly uses process.env['NX_URL_GITHUB_API_GO_RELEASES'].
  • The search for NX_URL_GITHUB_API_ZZZ_RELEASES returned no results, indicating all instances have been updated.
.github/workflows/build-new-release.yml (1)

42-42: Looks good! stretches

The addition of .env.local for zzz-frontend aligns with the existing pattern. Nice and consistent!

.github/workflows/build-frontend.yml (1)

63-63: Another .env setup... consistent! yawns again

The .env.local setup for zzz-frontend matches the pattern in build-new-release.yml. Good consistency across workflows!

@frzyc frzyc requested a review from nguyentvan7 February 12, 2025 22:01
@frzyc frzyc added the ZO Zenless Optimizer label Feb 12, 2025
@frzyc frzyc changed the title ZO Add a roadmap to home page ZO: Add a roadmap to home page Feb 12, 2025
@frzyc frzyc merged commit 15e5352 into master Feb 12, 2025
@frzyc frzyc deleted the zo_roadmap branch February 12, 2025 22:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ZO Zenless Optimizer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ZO: Add a Roadmap to homepage

2 participants