libp2p / docs

Documentation site for the libp2p project.
https://docs.libp2p.io/
Other
62 stars 89 forks source link

Suggestion: i18n the docs. Such as translate it into Chinese. #178

Closed SuccinctPaul closed 2 years ago

SuccinctPaul commented 2 years ago

Suggestion like the title.

salmad3 commented 2 years ago

Hi @ChengYueJia, thanks for the suggestion. This is something planned and we'll provide an update shortly on internationalization of the docs

SuccinctPaul commented 2 years ago

Glad to hear it. @DannyS03

Two more questions: Has it been scheduled? Has the Chinese version finished?

Actually, I wanna translate it into Chinese.

If u guys need, I can help to do it.

p-shahi commented 2 years ago

@ChengYueJia Yeah we definitely would love to have your help. PRs are always welcome

Has it been scheduled? Has the Chinese version finished?

Planned but not scheduled. So no Chinese version yet.

SuccinctPaul commented 2 years ago

@p-shahi Ok, I'll prepare for the Chinese Version PRs.

SuccinctPaul commented 2 years ago

Hi, @p-shahi @DannyS03 I've met a problem.

At first, I wanna organize the i18n files in different directories categories by lang. just like this one.

├── content
|   ├── en
|   |   ├── post-01.md
|   |   ├── post-02.md
|   ├── cn
|   |   ├── post-01.md
|   |   ├── post-02.md

Later I wanna to set the i18n config. And found docs of hugo-theme-learn, https://learn.netlify.app/en/cont/i18n/ But it shows the different organization as below. This is less organized than the former one.

image
p-shahi commented 2 years ago

Hey @ChengYueJia I was misinformed when asking you to contribute docs in other languages. After speaking with the team we decided that it will be difficult to maintain documentation in any language besides English as we do not have to resources necessary to write and proofread them. This is not libp2p specific as we don't maintain any localized version for IPFS or Filecoin. Our plan is to use a TMS which would automate translations in the future. For now I retract my ask for help and ask that we pause this effort. Thanks

SuccinctPaul commented 2 years ago

@p-shahi It's fine. Maybe TMS is a batter idea.

I've see the ethereum docs is using the crowding as the TMS.

Waiting for team's i18n scheduled time.

p-shahi commented 2 years ago

I'll close this issue then