XiangShan-doc icon indicating copy to clipboard operation
XiangShan-doc copied to clipboard

English and Spanish translation need branchs

Open greenpdx opened this issue 10 months ago • 3 comments

I have English and Spanish translation of Doc directory. I can not merge them in to main, my branches are trans-en and trans-es It would also be nice to have the original documents that the tutorial pdfs are made from.

greenpdx avatar Jan 09 '25 12:01 greenpdx

It might be interesting to add a block in mkdocs.yml to switch the language.

extra:
  alternate:
    - name: English
      link: /en/ 
      lang: en
    - name: Chinese
      link: /zh/
      lang: zh

MrVyM avatar Jan 09 '25 13:01 MrVyM

Nice job! Thanks a lot for your contribution!

I took a look at your repository and branches. I suggest naming the translated files as xxxx.en.md for English and xxxx.es.md for Spanish, and creating separate pull requests for English and Spanish. This way, we can review these contributions and later merge them into the main branch, and release them on docs.xiangshan.cc.

In fact, the microarchitecture documentation in the current XiangShan-Doc repository is somewhat outdated. We are working on a new version of the microarchitecture documentation, which may be split into a new repository. This will take about one to two months to complete.

Additionally, we are currently encountering some minor issues with the i18n plugin in the documentation generator, which may take some time to resolve.

cebarobot avatar Jan 09 '25 13:01 cebarobot

It might be interesting to add a block in mkdocs.yml to switch the language.

Yes, we have been looking at this for a while, and we found that there is a plugin that helps i18n. But the pulgin has some problems that we don't like, so we has not used it yet.

cebarobot avatar Jan 09 '25 13:01 cebarobot