kevin/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr synced 2026-08-26 14:13:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

style-guide: remove duplicated rules and update translation dashboard link (#20225)

Browse Source
This commit is contained in:
Ivan Baluta
2025-12-24 21:35:57 +02:00
committed by GitHub
parent 99d6270220
commit 54f079f0e7
2 changed files with 3 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+1 -1
View File
@@ -194,7 +194,7 @@ Translation of pages can be done by simply creating the corresponding page withi
> [!IMPORTANT]
> Only translate or update languages you can confidently read and proofread.
> Avoid machine-generated or bulk edits across languages you do not know.
> When you change an English page, it is fine to leave other languages untouched; native speakers and maintainers will sync them later via the translation dashboards.
> When you change an English page, it is fine to leave other languages untouched; native speakers and maintainers will sync them later by referring to the [translation dashboards](https://github.com/tldr-pages/tldr-maintenance/issues/127).
To see the current progress of all translations, you can visit <https://lukwebsforge.github.io/tldri18n/>, which provides a dynamically updated table of all pages and their translations or you can visit <https://github.com/tldr-pages/tldr-maintenance/issues/127>, which provides a dynamically updated list about the translation status (e.g. list all outdated pages) per language.
contributing-guides/style-guide.md
+2 -6
View File
@@ -239,10 +239,6 @@ Avoid explaining general UNIX concepts that could apply to any command (i.e. rel
When describing an environment variable for UNIX platforms, prepend the variable with a dollar sign and enclose it with backticks (`$VARIABLE_NAME`). For example: "Manage the `$JAVA_HOME` environment variable".
For Windows command prompt, prepend and append the environment variable with a percent sign and enclose it with backticks (`%VARIABLE_NAME%`). For example: "Manage the `%JAVA_HOME%` environment variable".
Whereas for Powershell, prepend the environment variable with a dollar sign, Env and a colon, then enclose it with backticks (`$Env:VARIABLE_NAME`). For example: "Manage the `$Env:JAVA_HOME` environment variable".
When describing file formats, primarily use the brand name in plain text (e.g. JSON, SQLite), or use the file extension preceded by a dot, wrapped in backticks (e.g. `.txt`).
If the command that is being described is part of an interactive mode, mention the word "interactive" in a previous example that enters said mode and mark the beginning of the description for the interactive commands with `[Interactive]`.
@@ -555,7 +551,7 @@ but add the word "In PowerShell," (or equivalent) to indicate that the command i
`tldr new-item`
```
**3. Provides a new alias that conflicts with other programs**, most notoriously the inclusion of `curl` and `wget` as aliases of `Invoke-WebRequest` (with a non-compatible set of command options).
3. **Provides a new alias that conflicts with other programs**, most notoriously the inclusion of `curl` and `wget` as aliases of `Invoke-WebRequest` (with a non-compatible set of command options).
Note that PowerShell system aliases that fall into this category are commonly exclusive to Windows.
In this case, provide a note and method to determine whether the command currently refers to a PowerShell command (by alias) or others. For example,
@@ -604,7 +600,7 @@ Do not translate `example.com`. The domain is [reserved by IANA for documentatio
> [!IMPORTANT]
> Only translate or update languages you can confidently read and proofread.
> Avoid machine-generated or bulk edits across languages you do not know.
> When you change an English page, it is fine to leave other languages untouched; native speakers and maintainers will sync them later via the translation dashboards.
> When you change an English page, it is fine to leave other languages untouched; native speakers and maintainers will sync them later by referring to the [translation dashboards](https://github.com/tldr-pages/tldr-maintenance/issues/127).
### English-Specific Rules