-
-
Notifications
You must be signed in to change notification settings - Fork 39
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
Create a multilingual documentation structure #149
Comments
As part of this issue, it is necessary to create the necessary documentation structure. When creating a Russian version of documentation, you must copy data from the English version. Translation of documentation into Russian will be carried out as a separate issue. |
@Naros could you write a short instruction on how to properly run this documentation locally to check the results of the changes? |
@Naros, please take a look, is this what the new documentation structure should look like? https://github.com/VladimirLevadnij/godot-orchestrator/tree/gh149/docs |
Hi @VladimirLevadnij the easiest thing to do is to install Node.js and once that's installed then you need to install Antora, which can be done by executing
This will build the docs inside the |
As I understand it, the
|
@Naros, Hi, I made the first pull request for this issue. There is such a demo example of multilingual documentation https://gitlab.com/antora-ui-custom/antora-i18n Here is the link to the UI demo https://antora-ui-custom.gitlab.io/antora-i18n But this example seemed to me at the current stage to be unnecessarily complex (there are many additional modules in this example), and as I saw in this example, the structure of the documentation changes, according to the example in the I did it differently at the moment:
This is what the documentation looks like in English: This is what the language switching window looks like: This is what the documentation looks like in Russian (there is no translation of the documentation itself yet, translation will be carried out as the next step in issue #150): |
The structure and logic of the documentation has been changed in accordance with the proposal of @Naros. |
This issue is no longer relevant due to the transfer of documentation to a separate repository. |
Description
Now the documentation is created on the Antora engine and the documentation structure is now monolingual. It is necessary to create a new multilingual documentation structure, for a start, for example for English and Russian.
Implementation ideas
@Naros proposed this new documentation structure:
The text was updated successfully, but these errors were encountered: