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

Thoughts on moving docs to docusaurus? #13769

Closed
mmahalwy opened this issue Dec 14, 2021 · 8 comments · Fixed by #13914
Closed

Thoughts on moving docs to docusaurus? #13769

mmahalwy opened this issue Dec 14, 2021 · 8 comments · Fixed by #13914
Assignees
Labels
type: docs For issues and PRs. Things related to documentation, such as changes in the manuals / API reference.

Comments

@mmahalwy
Copy link
Contributor

I figured it's becoming a standard tool for libraries. Thoughts on converting the docs to this?

Happy to take lead and convert the existing docs to docusaurus if you think it's valuable.

@mmahalwy
Copy link
Contributor Author

Could be a nice addition for v7 too!

@WikiRik
Copy link
Member

WikiRik commented Dec 16, 2021

I have never used it, but if it's really becoming more standard it might be good. Especially if it works well with the generation of the TypeScript things. @allawesome497 you might have more to say on this

@WikiRik WikiRik added the type: docs For issues and PRs. Things related to documentation, such as changes in the manuals / API reference. label Dec 16, 2021
@ephys
Copy link
Member

ephys commented Jan 7, 2022

We're encountering issues with esdocs in PR #13815

I've been researching alternatives, given esdocs hasn't been updated in 4 years, and I think docusaurus + docusaurus-plugin-typedoc could be a nice solution.

@ephys
Copy link
Member

ephys commented Jan 7, 2022

Did a small test and it works well enough. Still needs polish:

image

@mmahalwy
Copy link
Contributor Author

mmahalwy commented Apr 4, 2022

thanks for making this happen @ephys !

@ephys
Copy link
Member

ephys commented Apr 4, 2022

My pleasure 💜. I also want to thank @sdepold and @WikiRik for all the work they put into the new website

I'm really liking docusaurus too. It's going to allow for so many improvements to our documentation

@bishwo-dahal
Copy link
Contributor

bishwo-dahal commented Apr 5, 2022

My Suggestion: I feel like fonts are too big than normal blogs and websites. For reference, mozilla has perfect font for viewing. Adding to it, icons also feels too big. Other than this it is awesome ❤<3

@ephys
Copy link
Member

ephys commented Apr 5, 2022

Both MDN and our website use a font-size of 16px for the main text :o
Which icons do you mean?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs For issues and PRs. Things related to documentation, such as changes in the manuals / API reference.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants