Skip to content

Migrate Documentation to Nextra #71

@koladev32

Description

@koladev32

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.

Metadata

Metadata

Assignees

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions