Skip to content

[Feature Request] Update Docs Site #53

@kaihiroi

Description

@kaihiroi

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

  1. Switch to other documentation frameworks (VitePress, MkDocs)
  2. 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

No one assigned

    Labels

    status: todoIssues that need to be addressedtype: documentationIssues or pull request related to improving or adding documentationtype: featureIssues or pull requests related to new feature proposals or enhancements

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions