mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-03-05 21:00:08 -08:00
Add Docs Translations Guide (#1689)
* add header dedicated to translations * create docs translations guide * update position orders, formatting fixes
This commit is contained in:
rcarteraz
GitHub
parent
57ba5f6059
commit
46a02e1fe4
|
|
@ -36,11 +36,27 @@ Key components include:
|
|||
- **Firmware Modules**: Extend the core functionalities of devices and mesh networks, implemented mainly within the firmware repository. Modules are essential for adding new features and integrating devices within the ecosystem.
|
||||
- **CLI Apps (Device Interface)**: The [Meshtastic Python CLI](https://github.com/meshtastic/python) enables interaction with device settings and functionalities, serving both as a utility and a library for application development.
|
||||
- **Web and JavaScript Apps**: Development for the hosted web server on ESP32 devices is done in [Meshtastic Web](https://github.com/meshtastic/web), with a JavaScript library for device interfaces available in [Meshtastic JS](https://github.com/meshtastic/meshtastic.js).
|
||||
- **Mobile and Desktop Apps**: Android, iOS, iPadOS, and macOS applications provide user interfaces for interacting with Meshtastic devices. Development for Android is detailed in the [Meshtastic-Android repository](https://github.com/meshtastic/Meshtastic-Android), while Apple platforms are supported by the [Meshtastic-Apple repository](https://github.com/meshtastic/Meshtastic-Apple). Translations to your native language may be added by following instructions for [Android here](/docs/software/android/android-app-translate/), or for [Apple here](/docs/software/apple/apple-app-translate/).
|
||||
- **Mobile and Desktop Apps**: Android, iOS, iPadOS, and macOS applications provide user interfaces for interacting with Meshtastic devices. Development for Android is detailed in the [Meshtastic-Android repository](https://github.com/meshtastic/Meshtastic-Android), while Apple platforms are supported by the [Meshtastic-Apple repository](https://github.com/meshtastic/Meshtastic-Apple).
|
||||
- **Documentation**: The source for the Meshtastic website and documentation resides in the [meshtastic/meshtastic repository](https://github.com/meshtastic/meshtastic). For guidelines on maintaining documentation, visit the [Maintaining Documentation](/docs/development/docs) page.
|
||||
|
||||
This ecosystem is continuously evolving, thanks to the collaborative effort of developers, contributors and the community, aiming to enhance and expand Meshtastic's capabilities for decentralized off-grid communication.
|
||||
|
||||
### Translating Meshtastic
|
||||
|
||||
Meshtastic is a global project, and we strive to make our resources accessible to users worldwide. Translating our documentation and applications into multiple languages is a crucial step in achieving this goal. If you're fluent in multiple languages and would like to contribute to Meshtastic's localization efforts, we welcome your help in translating our resources.
|
||||
|
||||
#### Android App Translation
|
||||
|
||||
For details on how to translate the Meshtastic Android app, refer to the [guide for Android here](/docs/software/android/android-app-translate/).
|
||||
|
||||
#### Apple App Translation
|
||||
|
||||
For details on how to translate the Meshtastic Apple App, refer to the [guide for Apple here](/docs/software/apple/apple-app-translate/).
|
||||
|
||||
#### Documentation Translation
|
||||
|
||||
For details on how to translate the Meshtastic docs, refer to the [guide for documentation here](/docs/development/documentation/translate-docs/).
|
||||
|
||||
## Supporting and Contributing to Meshtastic
|
||||
|
||||
The Meshtastic project benefits greatly from the contributions of our volunteers and the financial support from our community. As the project has evolved, the expansion of features and services has led to increased financial needs, including hardware for development, GitHub fees, hosting for public MQTT services, among others. This growth into a robust platform for decentralized off-grid mesh networking solutions showcases the dedication of our developers and the generosity of our financial supporters.
|
||||
|
|
|
|||
|
|
@ -18,15 +18,15 @@ Another component that we use is [Vercel](https://vercel.com) — a platform for
|
|||
|
||||
## Documentation Organization
|
||||
|
||||
| Section | File Path | Description |
|
||||
| :----------------------: | :---------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| About Meshtastic | `docs/about` | A high level explanation of Meshtastic plus everything relating to the Meshtastic mesh. This includes radio settings, mesh algorithm and encryption. |
|
||||
| Getting Started | `docs/getting-started` | Instructions on how to get the Meshtastic firmware onto a users device. |
|
||||
| Device Settings | `docs/settings` | Details for both the device and module configurations. Details each user setting and offers explanations on their functionalities in addition to guiding the user on how to configure the device using the various clients available (Android, CLI, iOS, Web).|
|
||||
| Hardware Details | `docs/hardware` | Any hardware related content such as officially supported radios and their peripherals such as 3d printed cases, antennas, buttons, chime, rotary encoders, and screens. |
|
||||
| Meshtastic Software | `docs/software` | An overview of the current software used in conjunction with Meshtastic to include officially supported client and community applications. |
|
||||
| Contribute to Meshtastic | `docs/developers` | Details of the necessary information needed for developers to start contributing to the development of the Meshtastic project. |
|
||||
| Legal | `docs/legal` | Any legal information. Most changes here will be handled by developers actually working on the projects that require any legal disclosures. Examples include: the Meshtastic trademark, terms of service, and privacy policy. |
|
||||
| Section | File Path | Description |
|
||||
| :----------------------: | :--------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| About Meshtastic | `docs/about` | A high level explanation of Meshtastic plus everything relating to the Meshtastic mesh. This includes radio settings, mesh algorithm and encryption. |
|
||||
| Getting Started | `docs/getting-started` | Instructions on how to get the Meshtastic firmware onto a users device. |
|
||||
| Device Settings | `docs/settings` | Details for both the device and module configurations. Details each user setting and offers explanations on their functionalities in addition to guiding the user on how to configure the device using the various clients available (Android, CLI, iOS, Web). |
|
||||
| Hardware Details | `docs/hardware` | Any hardware related content such as officially supported radios and their peripherals such as 3d printed cases, antennas, buttons, chime, rotary encoders, and screens. |
|
||||
| Meshtastic Software | `docs/software` | An overview of the current software used in conjunction with Meshtastic to include officially supported client and community applications. |
|
||||
| Contribute to Meshtastic | `docs/developers` | Details of the necessary information needed for developers to start contributing to the development of the Meshtastic project. |
|
||||
| Legal | `docs/legal` | Any legal information. Most changes here will be handled by developers actually working on the projects that require any legal disclosures. Examples include: the Meshtastic trademark, terms of service, and privacy policy. |
|
||||
|
||||
## Quick Start
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: local-dev
|
||||
title: Serving Docs Locally for Development
|
||||
sidebar_label: Local Development
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
id: publish
|
||||
title: Publishing Meshtastic.org
|
||||
sidebar_label: Publish
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
## Publish Live
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ export const typedArrayToBuffer = (array: Uint8Array): ArrayBuffer => {
|
|||
export const typedArrayToBuffer = (array: Uint8Array): ArrayBuffer => {
|
||||
return array.buffer.slice(
|
||||
array.byteOffset,
|
||||
array.byteLength + array.byteOffset
|
||||
array.byteLength + array.byteOffset,
|
||||
);
|
||||
};
|
||||
```
|
||||
|
|
|
|||
18
docs/development/documentation/translate.mdx
Normal file
18
docs/development/documentation/translate.mdx
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
id: translate-docs
|
||||
title: Translate the Meshtastic Documentation
|
||||
sidebar_label: Translate
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
## How to Contribute
|
||||
|
||||
Contributing translations to the Meshtastic Documentation helps make the project accessible to a wider audience. Follow these steps to add your translations through Crowdin:
|
||||
|
||||
1. **Access Crowdin**: Visit the Meshtastic project's Crowdin page at [https://crowdin.meshtastic.org](https://crowdin.meshtastic.org).
|
||||
2. **Create an Account**: Click on 'Sign Up' in the top right corner of the page and follow the prompts to create a Crowdin account.
|
||||
3. **Navigate to the Project**: Once logged in, locate and select the 'Docs' project from the Crowdin dashboard.
|
||||
4. **Choose a Language**: Find the language you want to contribute translations for and select it. A list of the files that make up the Meshtastic documentation site will be shown. Select the file you want to translate, then click the 'Go to Editor' button at the top to start translating.
|
||||
5. **Start Translating**: In the editor, you'll see the file you are translating on the left-hand side. Items that can be translated, typically broken up by sentences, will be highlighted in red. Click on an item to select it, the highlight color will change to yellow to indicate it's selected. Then, enter your translation in the editor box on the right-hand side. When you're finished with an item (sentence), click 'Save' to store your translation. Repeat this process for each item you wish to translate.
|
||||
|
||||
Your contribution will be reviewed, and upon approval, your translation will be included in the Meshtastic documentation. Thank you for helping expand the reach of Meshtastic!
|
||||
Loading…
Reference in a new issue