docs(docs): start implementing docs website #1372
Conversation
docusaurus.mp4 |
python.mp4 |
| // Even if you don't use internationalization, you can use this field to set | ||
| // useful metadata like html lang. For example, if your site is Chinese, you | ||
| // may want to replace "en" with "zh-Hans". | ||
| i18n: { |
There was a problem hiding this comment.
Are we losing README-zh entirely?
There was a problem hiding this comment.
Well, we only have the main readme in Chinese anyway so we could keep that if we wanted to. In addition, Docusaurus has great i18n support.
However, I don't know how feasible it is at this point to translate everything and, more importantly, keep everything in sync between translations if things change. I'm not super convinced that we're at a point where we should spend time on multilingual docs. Creating them is one thing and can be done by volunteers but every time somebody update anything things basically break. If I change something I'd be able to change the docs for German and English, maybe Spanish that's it. Similar probably for most other people. How would we maintain consistency?
|
@Sparkier Do you know why the |
I think this is because some of the other hooks (e.g.
|
|
@yimothysu I think we need to exclude this autogenerated python dir for some hooks so that precommit works. Seems to work now. |
|
@Sparkier this is great! LMK when you have the conflicts addressed and we can get it in |
I started implementing a dedicated website for documentation and as a landing page.
I'm using docusaurus for this. It is based on react but supports documentation via markdown.
Deployment could be done to a separate branch and hosting could be done via GitHub pages. This way, we don't need an extra service and the build files of the docs don't pollute the repository.
If this is something we want to pursue, I'd want to clean this up a little bit and reference it from our main readme.
fix #73