From 1fbb0699620f770974d4564d6b21dcab1fa9bd0b Mon Sep 17 00:00:00 2001 From: Lena <126529524+acuteenvy@users.noreply.github.com> Date: Wed, 5 Mar 2025 18:44:10 +0000 Subject: [PATCH] CLIENT-SPECIFICATION: add the date of removal of the old asset website (#15862) Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> --- CLIENT-SPECIFICATION.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index 5ea89fdd82..c584c681b1 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -119,10 +119,9 @@ The structure inside these translation folders is identical to that of the main ## Page structure -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: -- Non-standard `{{`, `}}`, `{{[` and `]}}` placeholder syntax. - - `{{` and `}}` surrounds values in an example that indicates editable values. - - `{{[` and `]}}` indicate shortform and longform variants of options which are separated by a single `|`. Shortform on the left, longform on the right. +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: +- `{{` and `}}` surrounds values in an example that indicates editable values. +- `{{[` and `]}}` indicate shortform and longform variants of options which are separated by a single `|`. Shortform on the left, longform on the right. Things to take into account: - Clients MAY highlight the placeholders and MUST remove the surrounding curly braces. @@ -236,7 +235,8 @@ Step | Path checked | Outcome 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 **** or download language-specific archives in the format `https://github.com/tldr-pages/tldr/releases/latest/download/tldr-pages.{{language-code}}.zip` (e.g. ****). The English archive is also available from ****. > [!CAUTION] -> Prior to version 2.2, the client specification stated that clients MUST download archives from . This method is now deprecated, and **_will be removed_** in the future. +> Prior to version 2.2, the client specification stated that clients MUST download archives from . This method is now deprecated, and **_will be removed_** in December 2025. +> Clients that still use the old location will therefore stop working next year. 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.