-
Notifications
You must be signed in to change notification settings - Fork 7
Open
Labels
status: todoIssues that need to be addressedIssues that need to be addressedtype: documentationIssues or pull request related to improving or adding documentationIssues or pull request related to improving or adding documentationtype: featureIssues or pull requests related to new feature proposals or enhancementsIssues or pull requests related to new feature proposals or enhancements
Milestone
Description
Problem
Current documentation site uses the default Docusaurus theme, making it look generic and unprofessional. This reduces our library's credibility and makes it harder for users to navigate through documentation.
Solution
- Implement custom theme with modern UI styling
- Improve navigation and search functionality
- Update custom landing page
- Update document structure & contents
- Update NatSpec documentation
Alternatives
- Switch to other documentation frameworks (VitePress, MkDocs)
- Use pre-made Docusaurus themes
Both options would limit our customization ability and may not meet our specific needs.
Additional context
Currently using Docusaurus v3. Looking to reference modern documentation sites like Vocs and VitePress for inspiration.
Metadata
Metadata
Assignees
Labels
status: todoIssues that need to be addressedIssues that need to be addressedtype: documentationIssues or pull request related to improving or adding documentationIssues or pull request related to improving or adding documentationtype: featureIssues or pull requests related to new feature proposals or enhancementsIssues or pull requests related to new feature proposals or enhancements