-
Notifications
You must be signed in to change notification settings - Fork 32
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
This PR ships versioning support. #3
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! I'm not an expert in frontend development, but the changes here seem great!! (Meanwhile, I should probably start ripping http://taichi.graphics/me/ off http://taichi.graphics/ :-p)
Co-authored-by: Yuanming Hu <yuanming-hu@users.noreply.github.com>
Thanks for taking a look! I'm not familiar with frontend development either, and using this chance to learn more about the modern frontend technologies. I hope the this framework is not over-complicated and can help us spend minimal time on the infrastructure so we produce great documentation+tutorials+events+research-posts, etc. I'm also pretty certain there will be frontend exerts in the taichi community who can help us improve this site! When it comes to go-live:
|
I'll try my best to have this done by this Sunday (Oct 11).
Great! That would be very helpful to newcomers (and potentially existing members!)
I think we can first set the new English version up, while still refer readers to the old Chinese docs on readthedocs. I guess there will be a way to reuse the Since now the documents live in two copies (
Yeah, I believe @StephenArk30 will have insights on how to reuse the existing |
This PR ships versioning support, it is a working MVP, but not yet perfect. The following parts need to be improved, but can be future work:
in order to support both versioning and i18n need to make it
more sophisticated and less DRY.
it can jump back and forth if users decide to:
this needs to be fixed along with the vuepress i18n support, which
can be difficult.
yarn
also build all available versioned docs (this is the same behaivor as ReadTheDocs), however, I can see this can dramatically slow down doc writter's hot-reload if we have hundreds of versions in the future. We should only SHOW + BUILD, say 10 or 15 most recent versions, we should also consider ONLY release up-to minor (but no patch or release candidates versions) versioned documentations. This can be discussed in the main repo though.