Skip to content

Commit 1fbb069

Browse files
acuteenvyManagor
andauthored
CLIENT-SPECIFICATION: add the date of removal of the old asset website (#15862)
Co-authored-by: Managor <42655600+Managor@users.noreply.github.com>
1 parent 315f1e2 commit 1fbb069

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

CLIENT-SPECIFICATION.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,9 @@ The structure inside these translation folders is identical to that of the main
119119

120120
## Page structure
121121

122-
Although this specification is about the interface that clients must provide, it is also worth noting that pages are written in standard [CommonMark](https://commonmark.org/), with the exceptions:
123-
- Non-standard `{{`, `}}`, `{{[` and `]}}` placeholder syntax.
124-
- `{{` and `}}` surrounds values in an example that indicates editable values.
125-
- `{{[` and `]}}` indicate shortform and longform variants of options which are separated by a single `|`. Shortform on the left, longform on the right.
122+
Although this specification is about the interface that clients must provide, it is also worth noting that pages are written in standard [CommonMark](https://commonmark.org/), with the exception of the non-standard `{{`, `}}`, `{{[` and `]}}` placeholder syntax, where:
123+
- `{{` and `}}` surrounds values in an example that indicates editable values.
124+
- `{{[` and `]}}` indicate shortform and longform variants of options which are separated by a single `|`. Shortform on the left, longform on the right.
126125

127126
Things to take into account:
128127
- Clients MAY highlight the placeholders and MUST remove the surrounding curly braces.
@@ -236,7 +235,8 @@ Step | Path checked | Outcome
236235
If appropriate, it is RECOMMENDED that clients implement a cache of pages. If implemented, clients MUST download the entire archive either as a whole from **<https://github.com/tldr-pages/tldr/releases/latest/download/tldr.zip>** or download language-specific archives in the format `https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.{{language-code}}.zip` (e.g. **<https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.en.zip>**). The English archive is also available from **<https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.zip>**.
237236

238237
> [!CAUTION]
239-
> Prior to version 2.2, the client specification stated that clients MUST download archives from <https://tldr.sh/assets>. This method is now deprecated, and **_will be removed_** in the future.
238+
> Prior to version 2.2, the client specification stated that clients MUST download archives from <https://tldr.sh/assets>. This method is now deprecated, and **_will be removed_** in December 2025.
239+
> Clients that still use the old location will therefore stop working next year.
240240
241241
Caching SHOULD be done according to the user's language configuration (if any), to not waste unneeded space for unused languages. Additionally, clients MAY automatically update the cache regularly.
242242

0 commit comments

Comments
 (0)