[FEAT] Documentation Page

abhilashreddysh commented 2 months ago

Fixes issue

Fixes #273

Changes proposed

Separate documentation page

Screenshots

Note to reviewers

Added nextra as documentation in the current website

Summary by CodeRabbit

New Features
- Added a "Docs" navigation link to both the Header and MobileNav components for improved access to documentation.
- Introduced the ReleaseInfo component to display release information from a GitHub repository.
- Created new metadata files and structured documentation for enhanced organization and navigation.
Enhancements
- Improved presentation of documentation using structured components such as Callout and Steps.
- Expanded Tailwind CSS configurations to include styles from Markdown files for consistent styling across documentation.
Documentation
- Updated various documentation files for better clarity, organization, and user guidance, including installation instructions and FAQs.

vercel[bot] commented 2 months ago

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

Name	Status	Preview	Comments	Updated (UTC)
drifty	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 21, 2024 2:50am

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent updates to the Drifty project's documentation enhance user accessibility and navigation by introducing a structured framework for documentation. Key features include new navigation links for documentation, a dedicated ReleaseInfo component for displaying release data, and organized metadata structures for various documentation sections. These changes aim to improve user experience and streamline the onboarding process for new users, making it easier to find relevant information.

Changes

File	Change Summary
`Website/app/Header.js`	Added a "Docs" navigation link to `MobileNav` and `Header` components.
`Website/components/Releases.jsx`	Introduced `ReleaseInfo` component to fetch and display release information from GitHub.
`Website/next.config.js`	Updated to integrate Nextra theme into Next.js configuration.
`Website/package.json`	Added `"nextra"` and `"nextra-theme-docs"` dependencies for enhanced documentation capabilities.
`Website/pages/_app.js`	Created a custom App component for universal styling and layout across the application.
`Website/pages/_meta.json`	Defined metadata structure for site navigation and documentation.
`Website/pages/docs/_meta.json`	Established structured metadata for documentation sections.
`Website/pages/docs/contribution.mdx`	Added front matter and `Steps` component for enhanced documentation on contributions.
`Website/style.css`	Introduced an empty CSS stylesheet for future styling.
`Website/theme.config.jsx`	Configured UI elements and settings for the Drifty documentation site.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Header
    participant MobileNav
    participant ReleaseInfo

    User->>Header: Open website
    Header->>MobileNav: Render navigation
    MobileNav->>User: Show "Docs" link
    User->>ReleaseInfo: Request release data
    ReleaseInfo->>GitHub: Fetch latest releases
    GitHub->>ReleaseInfo: Send release data
    ReleaseInfo->>User: Display release information

Assessment against linked issues

Objective	Addressed	Explanation
Add documentation sections	✅
Improve organization of docs	✅
Include quickstart instructions	✅
Provide contribution guidelines	✅
Enhance FAQ section	✅

Poem

🐇 In the meadow where we hop,
New docs bloom, they never stop!
Links to guides, so clear and bright,
Drifty's path, a joyful sight.
With every click, our knowledge grows,
A rabbit's cheer, the wisdom flows! 🌼📚

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.

abhilashreddysh commented 2 months ago

@SaptarshiSarkar12 , This is a draft. Need to add more documentation pages, just added what I got from the other PR #378. It would be helpful if you provide any MDX files that I can add, so I can test them if everything works perfectly before merge.

Here's the link. Let me know if anything needs to be changed.

abhilashreddysh commented 2 months ago

Change log -

Removed Docs point from sidebar
Added Discoed link on the top navigation bar
Added Drifty logo on top left nav bar (points to main home page)
Added direct link for downloads page
Added Banner for announcements
Added tailwind support for markdown
And some other minor changes

abhilashreddysh commented 2 months ago

Changelog -

New Page Release Notes
Added tags for releases

SaptarshiSarkar12 commented 2 months ago

@SaptarshiSarkar12 , This is a draft. Need to add more documentation pages, just added what I got from the other PR #378. It would be helpful if you provide any MDX files that I can add, so I can test them if everything works perfectly before merge.

@abhilashreddysh Thank you for testing your PR from your end :smile:. The website docs page works awesome. Once #378 gets merged, you can just use those mdx files for further improvements.

Here's the link. Let me know if anything needs to be changed.

I have already seen the docs website and it is responsive. I'll review this PR once #378 gets completed because this PR depends on that.

SaptarshiSarkar12 commented 4 weeks ago

@abhilashreddysh The PR for adding the Markdown files required for the documentation site has been successfully merged. You can now start working on making the necessary changes to render those markdown files on the website. Please resolve the merge conflicts before you start working. If you face any issue, please do let me know.