kleros / kleros-v2

Kleros version 2
https://v2.kleros.builders
MIT License
62 stars 44 forks source link

Links to specific mini-guides #1666

Closed jaybuidl closed 3 months ago

jaybuidl commented 3 months ago

Follow-up on #1607 to support the other mini-guides

⚠️ #onboarding has been renamed to #onboarding-miniguide for consistency

Mini-guide paths:


PR-Codex overview

This PR adds mini guides functionality to the application, allowing users to access specific guides.

Detailed summary

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent updates enhance the management of mini-guide functionality in the MainStructureTemplate and DesktopHeader components. A new array of mini-guide hashes is introduced for improved navigation control, allowing users to access various mini-guides more seamlessly. Additionally, the DesktopHeader component now supports multiple mini-guide visibility states and simplifies hash checking, boosting the overall user experience through added interactivity and streamlined code management.

Changes

File Change Summary
web/src/components/Popup/MiniGuides/MainStructureTemplate.tsx Introduced miniGuideHashes for multiple guides, replaced removeOnboardingHashPath with removeMiniGuideHashPath, and updated onCloseAndRemoveOnboardingHashPath to use the new function.
web/src/layout/Header/DesktopHeader.tsx Added new mini-guide components and states, refactored URL hash checking using a helper function, and updated rendering logic to include new mini-guides.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Header
    participant MiniGuides

    User->>Header: Navigate with a hash
    Header->>MiniGuides: Check hash for mini-guide
    MiniGuides-->>Header: Return corresponding guide state
    Header-->>User: Display appropriate mini-guide

Poem

🐇 In the meadow, guides now bloom,
With hashes guiding through the gloom.
A hop, a skip, to find your way,
Mini guides brighten up the day!
Navigate with ease and cheer,
New paths ahead, the guides are here! 🌼


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
netlify[bot] commented 3 months ago

Deploy Preview for kleros-v2-university ready!

Name Link
Latest commit 50883f18fc7f1be56ae7fa25262bd72f9d30095c
Latest deploy log https://app.netlify.com/sites/kleros-v2-university/deploys/66abc8896a16c0000851cea5
Deploy Preview https://deploy-preview-1666--kleros-v2-university.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] commented 3 months ago

Deploy Preview for kleros-v2-testnet ready!

Name Link
Latest commit 50883f18fc7f1be56ae7fa25262bd72f9d30095c
Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet/deploys/66abc88942cf770008a54a3d
Deploy Preview https://deploy-preview-1666--kleros-v2-testnet.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] commented 3 months ago

Deploy Preview for kleros-v2-neo ready!

Name Link
Latest commit 50883f18fc7f1be56ae7fa25262bd72f9d30095c
Latest deploy log https://app.netlify.com/sites/kleros-v2-neo/deploys/66abc889dc07250008b7d0ad
Deploy Preview https://deploy-preview-1666--kleros-v2-neo.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codeclimate[bot] commented 3 months ago

Code Climate has analyzed commit 50883f18 and detected 0 issues on this pull request.

View more on Code Climate.

sonarcloud[bot] commented 3 months ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud