Open abhilashreddysh opened 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 |
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.
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. |
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
Objective | Addressed | Explanation |
---|---|---|
Add documentation sections | β | |
Improve organization of docs | β | |
Include quickstart instructions | β | |
Provide contribution guidelines | β | |
Enhance FAQ section | β |
π 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?
@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.
Change log -
Changelog -
@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.
@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.
@abhilashreddysh Please fix the following errors:
Founderrors when linting JSX_PRETTIER. Exit code: 1.
_PRETTIER
@abhilashreddysh Please fix the following errors:
Founderrors when linting JSX_PRETTIER. Exit code: 1.
_PRETTIER
@abhilashreddysh Please fix the following errors:
Founderrors when linting JSX_PRETTIER. Exit code: 1.
_PRETTIER
@abhilashreddysh Please fix the following errors:
Founderrors when linting JSX_PRETTIER. Exit code: 1.
_PRETTIER
@abhilashreddysh Please fix the following errors:
Founderrors when linting JSX_PRETTIER. Exit code: 1.
_PRETTIER
@abhilashreddysh Please fix the following errors:
_PRETTIER
@abhilashreddysh Please fix the following errors:
_PRETTIER
@abhilashreddysh Please fix the following errors:
_PRETTIER
@abhilashreddysh Please fix the following errors:
_PRETTIER
@abhilashreddysh Please fix the following errors:
_PRETTIER
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
ReleaseInfo
component to display release information from a GitHub repository.Enhancements
Callout
andSteps
.Documentation