Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp docs structure #489

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Revamp docs structure #489

wants to merge 11 commits into from

Conversation

nehagup
Copy link
Member

@nehagup nehagup commented Feb 5, 2025

This pull request includes several changes to the documentation and UI components to improve the user experience and update the content. The most important changes include updates to the navigation labels and structure, enhancements to the Intro component, and renaming of certain components.

Updates to navigation labels and structure:

  • docusaurus.config.js: Changed the label from "Installation" to "Getting Started" and updated the navigation structure to include "Enterprise" and "Resources" sections, with links to blogs, contributing guide, and glossary. Added a "Pricing" link to the header. [1] [2] [3]

Enhancements to Intro component:

  • src/components/Intro.js: Updated the Languages section to change the header to "QuickStart" and added tooltips for various languages. Enhanced the Frameworks section by adding tooltips and hover effects for different frameworks. Updated the main header to "Getting Started ✨" and added a description for quick-start guides. [1] [2] [3] [4]

Renaming of components:

  • src/components/DevScribe.js (renamed from src/components/GitTogether.js): Updated the component to reflect the new name "DevScribe" and changed the associated links and image references.

Minor UI fixes:

Please include a summary of the change.

This PR Resolves #(issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • Documentation update (if none of the other choices apply).

How Has This Been Tested?

Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

@nehagup
Copy link
Member Author

nehagup commented Feb 5, 2025

@Sonichigo please fix the following pointers.

  • Screen responsiveness is breaking.
Screenshot 2025-02-05 at 9 59 01 PM Screenshot 2025-02-05 at 9 59 17 PM Screenshot 2025-02-05 at 10 01 26 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants