search

lexicongovernance / pluraltools-frontend

Frontend implementation of the plural voting tool.
https://demo.lexicongovernance.org/
GNU General Public License v3.0
3 stars 1 forks source link

687 add onboarding to develop #694

Closed camilovegag closed 3 months ago

camilovegag commented 3 months ago

Closes: #687

Summary by CodeRabbit

vercel[bot] commented 3 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
forum-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 22, 2024 3:48pm
coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes introduce an onboarding feature across multiple components, enhancing user experience by providing interactive guided tours. This includes a new Onboarding component utilizing the react-joyride library, which presents steps that guide users through various functionalities within the application. Additionally, the state management for onboarding status has been refined for better tracking of user progress. Overall, these modifications significantly improve user engagement and navigation.

Changes

Files Change Summary
package.json Added dependency for react-joyride to facilitate onboarding features.
packages/berlin/src/components/onboarding/Onboarding.tsx Introduced Onboarding component for guided tours with steps and event handling.
packages/berlin/src/components/onboarding/Onboarding.styled.tsx Created styled component OnboardingCard for better visual presentation of onboarding content.
packages/berlin/src/components/onboarding/index.ts Added index file for easier imports of the Onboarding component.
packages/berlin/src/components/tables/results-table/ResultsTable.tsx Modified ResultsTable to use LucideIcon, simplifying the component's structure.
packages/berlin/src/pages/Cycle.tsx Enhanced Cycle page with onboarding steps guiding users through voting actions.
packages/berlin/src/pages/Event.tsx Integrated onboarding steps into the Event component, providing guidance on event features.
packages/berlin/src/pages/Results.tsx Added onboarding functionality to the Results page, detailing key features and interactions.
packages/berlin/src/store/index.ts Updated AppState to manage onboarding status with a more granular structure, allowing for flexible updates.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Onboarding
    participant AppStore

    User->>Onboarding: Start Onboarding
    Onboarding->>AppStore: Check onboarding status
    alt Status INCOMPLETE
        Onboarding->>User: Display onboarding steps
        User->>Onboarding: Complete step
        Onboarding->>AppStore: Update status
    end
    User->>Onboarding: Finish onboarding
    Onboarding->>AppStore: Set status to COMPLETE

🐰 In the garden with hops and glee,
New paths of guidance bloom for thee!
With joyful steps, we guide the way,
Discovering treasures in bright array.
So hop along, embrace the tour,
With every click, you’ll learn for sure! 🌼

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.