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

Migrate Documentation to Nextra #71

Open
koladev32 opened this issue Oct 27, 2024 · 0 comments
Open

Migrate Documentation to Nextra #71

koladev32 opened this issue Oct 27, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation hacktoberfest help wanted Extra attention is needed

Comments

@koladev32
Copy link
Owner

koladev32 commented Oct 27, 2024

Is your feature request related to a problem? Please describe.

We are currently using Read the Docs, which, while reliable, has limited customization options and lacks modern UX features like dark mode, advanced search, and intuitive navigation. As our documentation expands, it’s becoming harder to maintain readability and easy access to key information.

Describe the solution you'd like

Switch the documentation framework from Read the Docs to Nextra. Nextra provides a streamlined, modern interface with built-in features like dark mode, a table of contents, and improved navigation that enhances the overall user experience. It allows for easy Markdown-based editing, making it simpler for the team to update and maintain content.

Describe alternatives you’ve considered

  • Continuing with Read the Docs: While familiar, it lacks advanced customization options and UX enhancements. As documentation grows, it becomes challenging to maintain a polished, user-friendly experience.
  • Docusaurus: A viable option with extensive features, but it’s heavier and requires more configuration than Nextra, which is designed for simplicity and clean, responsive documentation sites.

Additional context

Nextra’s design and features align well with our needs for flexibility, customization, and an improved user experience. The transition to Nextra would also reduce maintenance time for developers while providing users with a modern, easily navigable documentation site.

@koladev32 koladev32 added documentation Improvements or additions to documentation help wanted Extra attention is needed hacktoberfest labels Oct 27, 2024
@koladev32 koladev32 self-assigned this Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant