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

refactor(website): documentation website redesign #13985

Closed
d1onys1us opened this issue Jun 13, 2023 · 5 comments
Closed

refactor(website): documentation website redesign #13985

d1onys1us opened this issue Jun 13, 2023 · 5 comments

Comments

@d1onys1us
Copy link
Contributor

No description provided.

@d1onys1us d1onys1us changed the title website redesign documentation website redesign Jun 13, 2023
@invictusbtc
Copy link

Add a Quest tab on the site as on Optimism. Increase the level of community engagement with these quests.

@d1onys1us
Copy link
Contributor Author

Add a Quest tab on the site as on Optimism. Increase the level of community engagement with these quests.

any thoughts on this @MarcusWentz ?

@2manslkh
Copy link
Contributor

If we are going for questing we could do something with Zealy

@dantaik
Copy link
Contributor

dantaik commented Jul 15, 2023

Any decision on this one?

@d1onys1us
Copy link
Contributor Author

Any decision on this one?

yes but this is a bit lower priority (still in q3 though). for now, we will just enhance nextra.

in terms of documentation framework, i'd like something more flexible that supports svelte ideally (keeping an eye on https://github.com/withastro/starlight). i don't want to move to docusaurus or vitepress if they do not support all the features we want, chiefly:

  • dynamically rendering child pages in the parent (docusaurus does this, vitepress is hacky with plugins)
  • permalinks to docs
  • transclusion with docs (mdx supports this, but i'd like a more powerful syntax that supports inheriting just sections of docs)

in terms of our website, we will do a landing page at taiko.xyz, and docs at docs.taiko.xyz. this website will simply use svelte.

so basically, this is on hold. cc @2manslkh @MarcusWentz i have been active in the astro discord to try to bring some of these features to starlight. in the meantime, been opening issues in the nextra repo. so i think we can work with what we have, and move once we have a really solid framework to commit to.

@dantaik dantaik changed the title documentation website redesign refactor(website): documentation website redesign Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

4 participants