UI: foundation for the new docs section of the website

avikalpg commented 3 months ago

Added SideBar and RenderMarkdown components.
Created DocsSideBar view to use Sidebar in the documentation section
Added all the pages for the User Guide section of the documentation.

Summary by CodeRabbit

New Features
- Introduced RenderMarkdown component for rendering markdown text.
- Added SideBar component for sidebar navigation with collapsible items.
- Added BitbucketInstallation and GithubInstallation components for setup guides.
- Introduced QuickStartGuide component for Vibinex setup.
- Added TroubleshootingPages component with dynamic routing for troubleshooting guides.
- Introduced guides for starting a VM in the cloud and troubleshooting Docker command issues.
Improvements
- Enhanced documentation navigation with DocsSideBar.
- Updated next.config.js for better handling of GitHub README images.

vercel[bot] commented 3 months ago

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

Name	Status	Preview	Comments	Updated (UTC)
team-monitor-website	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 7, 2024 5:48am

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent updates introduce several new components and enhance existing ones in a React-based documentation site. Key additions include markdown rendering, sidebar navigation, various installation guides, and troubleshooting pages. The changes also involve updates to the Next.js configuration for handling GitHub README images and significant modifications to the main documentation index page to streamline content and improve user interaction.

Changes

Files/Paths	Change Summary
`components/RenderMarkdown.tsx`	Added `RenderMarkdown` component for rendering markdown with GitHub Flavored Markdown support.
`components/SideBar.tsx`	Introduced `SideBar` component for sidebar navigation with collapsible items.
`next.config.js`	Added rewrites for handling GitHub README images.
`pages/docs/bitbucket-installation.tsx`	Added `BitbucketInstallation` guide component.
`pages/docs/github-installation.tsx`	Added `GithubInstallation` guide component.
`pages/docs/index.tsx`	Overhauled index page: updated imports, state management, and logic for theme and markdown content.
`pages/docs/quickstart.tsx`	Introduced `QuickStartGuide` component for setting up Vibinex.
`pages/docs/troubleshooting/index.tsx`	Added `TroubleshootingPages` component for listing and routing troubleshooting guides.
`pages/docs/troubleshooting/starting-vm-in-cloud.tsx`	Provided guide on starting a VM in the cloud for Vibinex DPU.
`pages/docs/troubleshooting/unable-to-run-docker-command.tsx`	Added `UnableToRunDockerCommand` component with troubleshooting tips for Docker issues.
`views/docs/DocsSideBar.tsx`	Introduced `DocsSideBar` component for documentation navigation.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant DocsPage
    participant RenderMarkdown
    participant SideBar
    participant DocsSideBar

    User->>DocsPage: Navigate to documentation page
    DocsPage->>RenderMarkdown: Render markdown content
    RenderMarkdown-->>DocsPage: Return rendered markdown
    DocsPage->>SideBar: Render sidebar navigation
    SideBar-->>DocsPage: Return sidebar component
    DocsPage->>DocsSideBar: Render documentation sidebar
    DocsSideBar-->>DocsPage: Return documentation sidebar component
    DocsPage-->>User: Display documentation page with content and navigation

Poem

In the realm of code, where changes flow,
New guides and docs now brightly glow.
With markdown flair and sidebars grand,
Installation steps at your command.
Troubleshooting paths, clear and bright,
Vibinex setup, a guiding light.
🌟✨

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