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

[Feature Request] Update Docs Site #53

Open
4 of 5 tasks
kaihiroi opened this issue Oct 25, 2024 · 0 comments
Open
4 of 5 tasks

[Feature Request] Update Docs Site #53

kaihiroi opened this issue Oct 25, 2024 · 0 comments
Labels
status: todo Issues that need to be addressed type: documentation Issues or pull request related to improving or adding documentation type: feature Issues or pull requests related to new feature proposals or enhancements

Comments

@kaihiroi
Copy link
Contributor

kaihiroi commented Oct 25, 2024

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.

@kaihiroi kaihiroi added status: todo Issues that need to be addressed type: feature Issues or pull requests related to new feature proposals or enhancements labels Oct 25, 2024
@kaihiroi kaihiroi changed the title [Feature Request] Update Docs [Feature Request] Update Docs Site Oct 25, 2024
@kaihiroi kaihiroi added the type: documentation Issues or pull request related to improving or adding documentation label Oct 31, 2024
@kaihiroi kaihiroi added this to the Version 0.2.0 Release milestone Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: todo Issues that need to be addressed type: documentation Issues or pull request related to improving or adding documentation type: feature Issues or pull requests related to new feature proposals or enhancements
Projects
None yet
Development

No branches or pull requests

1 participant