search

asyncapi / website

AsyncAPI specification website
https://www.asyncapi.com
Apache License 2.0
526 stars 668 forks source link

feat: add fullscreen mode for documentation pages #3365

Closed Manancode closed 2 weeks ago

Manancode commented 3 weeks ago

Added a fullscreen toggle feature to enhance the reading experience of documentation pages. The toggle will only appear on the navbar on /docs page

Tested locally ( works fine )

closes issue

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

A new React functional component named FullscreenToggle has been added to the project. This component manages fullscreen functionality and is integrated into the DocsLayout component, which now wraps the DocsContext.Provider with the FullscreenToggle. The FullscreenToggle allows users to enter or exit fullscreen mode, updating its state accordingly. The overall structure of the DocsLayout remains intact, preserving existing features such as error handling and conditional rendering.

Changes

File Change Summary
components/FullScreenToggle.tsx Added FullscreenToggle component with props for children and className, and fullscreen logic.
components/layout/DocsLayout.tsx Integrated FullscreenToggle into DocsLayout, wrapping DocsContext.Provider.

Poem

In a world of screens so wide,
A toggle now, we take in stride.
With a click, the view expands,
A rabbit's joy in pixel lands!
Fullscreen dreams, so bright and clear,
Hop along, the magic's 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 , 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 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](http://discord.gg/coderabbit) 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 weeks ago

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
Latest commit 66a3b5a0b8a67800a590934ab85992c341bc2299
Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/672b371f24069f00086970cf
Deploy Preview https://deploy-preview-3365--asyncapi-website.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.

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 49.14%. Comparing base (dfd08dd) to head (66a3b5a). Report is 14 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #3365 +/- ## ======================================= Coverage 49.14% 49.14% ======================================= Files 21 21 Lines 647 647 ======================================= Hits 318 318 Misses 329 329 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

asyncapi-bot commented 3 weeks ago
⚡️ Lighthouse report for the changes in this PR: Category Score
🔴 Performance 45
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3365--asyncapi-website.netlify.app/

anshgoyalevil commented 2 weeks ago

@Manancode The button doesn't look very intuitive. An end user can go on a full screen mode via native browser features

Manancode commented 2 weeks ago

Sir even i didnt felt any need for it but since no one reviewed the issue so just made a PR incase needed

anshgoyalevil commented 2 weeks ago

Closing the linked issue since there doesn't seems to be a need for this feature at the moment. Other popular documentation frameworks like Docusaurus doesn't offer such a functionality