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 Wiki to Docusaurus #10

Closed
raxhvl opened this issue Feb 13, 2024 · 3 comments
Closed

✨ Migrate Wiki to Docusaurus #10

raxhvl opened this issue Feb 13, 2024 · 3 comments

Comments

@raxhvl
Copy link
Member

raxhvl commented Feb 13, 2024

We discussed in our town hall that one of the core objective is to gather all things Ethereum and make them readily accessible. But for this knowledge base to flourish, everyone needs to know it exists. To achieve this, I propose migrating to Docusaurus for our website. Here are the benefits over docsify:

  • 🔍 Improved Search: Docusaurus offers a powerful built-in search feature, making it easier for users to find information. Algolia Doc search is free for all open source projects.
  • 👁‍🗨 Better SEO: Docusaurus uses static site generation, boosting our wiki's visibility in search engines and attracting more users. SEO support is broken for docsify.
  • 🧮 Math Equations: Support for Math Equations and mermaid diagrams
  • 📟 Better UX: Lots of small features like tabs and, the automatically generated Index page:
    image
  • 💽 [Optional] Versioning: Ethereum landscape is evolving, we could use versions for forks.
  • 📊 [Optional] Analytics: Adding analytics can help us refine our content based on user feedback.

I am willing to take up. Existing markdown files can be easily ported over.

@taxmeifyoucan
Copy link
Contributor

Thanks for the suggestion!
When choosing which documentation engine to use for the wiki, we also considered Docusaurus. Docsify was chosen because it has mostly the same features in more simply design without redundancy. The goal is to keep it simple and Docsify achieves that. It's possible to enhance it with additional plugins like for math, tabs or search. This works well enough for now and I don't see strong benefits from migrating. However anyone can create a mirror with a deployment of their choice.
I will keep the issue open for subsequent discussion, if run into some limitations of docsify.

@raxhvl
Copy link
Member Author

raxhvl commented Feb 13, 2024

That makes sense. Thanks for the context.

@taxmeifyoucan
Copy link
Contributor

Closing as Docsify works well for now, feel free to reopen if any new issues come up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants