bitcashorg / smartsale

SmartSale streamlines the auction process on EVM
MIT License
11 stars 3 forks source link

feat: update whitepaper content #357

Closed ruge0326 closed 2 weeks ago

ruge0326 commented 2 weeks ago

Summary by Sourcery

Update the whitepaper content and structure by introducing a JSON-based format for easier management and rendering. Implement a new component-based architecture for the whitepaper page, enhancing navigation and content presentation. Add a hero section to provide an overview of the whitepaper, and improve the overall user interface with a more intuitive layout and emphasis on key information.

New Features:

Enhancements:

Summary by CodeRabbit

vercel[bot] commented 2 weeks ago

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
bitlauncher βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Sep 2, 2024 10:40pm
smartsale-faucet βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Sep 2, 2024 10:40pm
coderabbitai[bot] commented 2 weeks ago

[!WARNING]

Rate limit exceeded

@ruge0326 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 40 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. 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](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between dad22a227786458173b3d87838c1bcf9f72ab832 and 42632583af68ea41f85cedd6924758bcd2ed55bf.

Walkthrough

The changes involve a significant restructuring of the whitepaper-related components in the application. The WhitepaperPage component has been renamed and reorganized, introducing new components like WhitepaperPageLanding, WhitepaperContent, and HeroWhitepaper. Additional files for navigation and sidebar functionality have been added, enhancing the user interface for navigating the whitepaper. A constant for static content has also been introduced, and some imports have been simplified.

Changes

File Path Change Summary
apps/webapp/app/(routes)/[lang]/whitepaper/page.tsx Renamed BitlauncherWhitePaper to WhitepaperPage, added metadata, and simplified layout.
apps/webapp/components/routes/whitepaper/content.tsx Introduced WhitepaperContent component for dynamic content rendering and section navigation.
apps/webapp/components/routes/whitepaper/hero.tsx Introduced HeroWhitepaper component to display structured textual content with flexible formatting.
apps/webapp/components/routes/whitepaper/index.tsx Introduced WhitepaperPageLanding for a cohesive landing page structure with smooth scrolling.
apps/webapp/components/routes/whitepaper/navigator.tsx Introduced navigation components for section navigation with customizable arrow icons.
apps/webapp/components/routes/whitepaper/sidebar.tsx Introduced WhitepaperSidebar for mobile-friendly navigation through sections of the whitepaper.
apps/webapp/components/routes/whitepaper/static-content.ts Added WHITE_PAPER_HERO_CONTENT constant for structured hero section content.
apps/webapp/components/shared/transition.tsx Removed unused import of AnimatePresence from framer-motion.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WhitepaperPageLanding
    participant WhitepaperContent
    participant WhitepaperSidebar
    participant NavigationContainer

    User->>WhitepaperPageLanding: Load page
    WhitepaperPageLanding->>WhitepaperSidebar: Render sidebar
    WhitepaperPageLanding->>WhitepaperContent: Render content
    User->>WhitepaperSidebar: Click on section
    WhitepaperSidebar->>WhitepaperContent: Update active section
    WhitepaperContent->>NavigationContainer: Navigate to selected section

πŸ‡ "In a world of whitepapers bright,
I hop and skip with pure delight.
New pages, sections, all in a row,
With every click, my knowledge will grow!
So let’s celebrate this change today,
Hooray for the updates, hip-hip-hooray!" πŸŽ‰


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 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 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](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.
Early access features: disabled We are currently testing the following features in early access: - **Anthropic `claude-3-5-sonnet` for code reviews**: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues on the [discussion post](https://discordapp.com/channels/1134356397673414807/1279579842131787838).
sourcery-ai[bot] commented 2 weeks ago

Reviewer's Guide by Sourcery

This pull request updates the whitepaper content and structure, introducing new components for a more interactive and visually appealing presentation. The changes include the creation of new components for the whitepaper page, updates to the page routing, and modifications to existing components to support the new structure.

File-Level Changes

Change Details Files
Updated whitepaper content structure and introduced new components
  • Created a new whitepaper content structure in JSON format
  • Implemented new components for whitepaper presentation (Sidebar, Content, Navigator)
  • Added static content for the whitepaper hero section
  • Updated the whitepaper page component to use the new structure
apps/webapp/dictionaries/en/whitepaper.ts
apps/webapp/components/routes/whitepaper/content.tsx
apps/webapp/components/routes/whitepaper/sidebar.tsx
apps/webapp/components/routes/whitepaper/navigator.tsx
apps/webapp/components/routes/whitepaper/static-content.ts
apps/webapp/components/routes/whitepaper/index.tsx
apps/webapp/components/routes/whitepaper/hero.tsx
Updated page routing and component imports
  • Modified the whitepaper page component to use the new WhitepaperPageLanding component
  • Updated imports and removed unused components
apps/webapp/app/(routes)/[lang]/whitepaper/page.tsx
Minor updates to existing components
  • Removed AnimatePresence import from transition component
apps/webapp/components/shared/transition.tsx

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.