Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/academy redirect #427

Merged
merged 2 commits into from
Feb 14, 2024
Merged

Feat/academy redirect #427

merged 2 commits into from
Feb 14, 2024

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Feb 13, 2024

Address #424 using @docusaurus/plugin-client-redirects plugin.

Summary by CodeRabbit

  • New Features
    • Implemented a redirect from '/academy' to '/academy/overview' for improved navigation.
  • Refactor
    • Enhanced the readability of the dropdown menu configuration.

@ccamel ccamel self-assigned this Feb 13, 2024
Copy link
Contributor

coderabbitai bot commented Feb 13, 2024

Walkthrough

The recent update introduces a redirect configuration, enhancing user navigation by redirecting from '/academy' to '/academy/overview'. Additionally, it improves the legibility of the dropdown menu configuration by refining the formatting of the dropdownItemsAfter array, making it easier to read and manage.

Changes

Files Change Summary
docusaurus.config.js - Added redirect configuration for '/academy' to '/academy/overview'
- Modified formatting of dropdownItemsAfter array for improved readability

🐇✨
In the land of code and hue,
A rabbit hopped, making paths anew.
From 'academy' to 'overview', it leaped,
With cleaner menus, promises it keeps.
Hop, hop, hop, on the digital dew,
Crafting paths, for me and you.
🌟📚

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@bot-anik
Copy link
Member

Dependencies added

@docusaurus/plugin-client-redirects

DescriptionClient redirects plugin for Docusaurus.
LicenseMIT

Copy link
Contributor

@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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b2e80b4 and 4314a24.
Files ignored due to path filters (2)
  • package.json is excluded by: !**/*.json
  • yarn.lock is excluded by: !**/*.lock
Files selected for processing (1)
  • docusaurus.config.js (2 hunks)
Additional comments: 2
docusaurus.config.js (2)
  • 382-390: Ensure the redirect configuration syntax is correct and follows the @docusaurus/plugin-client-redirects plugin's expected format. Verify that the from and to paths are correctly specified to achieve the desired redirect behavior.
  • 183-185: The formatting changes to the dropdownItemsAfter array improve readability. Confirm that the array's new format aligns with JavaScript best practices for array declaration and readability.

Copy link
Member

@bot-anik bot-anik left a comment

Choose a reason for hiding this comment

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

Device URL
desktop http://localhost:3000/

Device URL
mobile http://localhost:3000/

Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead

Copy link
Member

@amimart amimart left a comment

Choose a reason for hiding this comment

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

Great :)

Copy link
Member

@MathieuConte MathieuConte left a comment

Choose a reason for hiding this comment

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

👏

@ccamel ccamel merged commit f1cd70c into main Feb 14, 2024
12 checks passed
@ccamel ccamel deleted the feat/academy-redirect branch February 14, 2024 09:04
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.

4 participants