huggingface / huggingface/candle

Add multilingual documentation structure for mdBook

Open
#3,094 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
21k
Forks
1.8k
Avg merge
16h 42m
Merged PRs (30d)
25

Description

Currently, the documentation is written in English and built with mdBook. It would be very helpful if the docs were structured in a way that supports multiple languages (for example, using `translations` directories or mdBook’s [[multilingual book setups](https://rust-lang.github.io/mdBook/format/summary.html#multilingual-books)](https://rust-lang.github.io/mdBook/format/summary.html#multilingual-books)).

I’m not very familiar with setting up this structure myself, but once the framework for multilingual docs is in place, I would be happy to contribute a full Korean translation right away.

This would make Candle’s documentation more accessible to non-English speakers and help grow the community further.

Thanks for considering this!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the current mdBook documentation setup and mdBook’s multilingual book setup guidance, including the suggested translations-directory approach. Done means the documentation has a clear structure that supports multiple languages and provides a practical path for adding the proposed Korean translation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, internationalization, localization
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.