Skip to content
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.

Sign up for GitHub

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

Jump to bottom

CLIENT-SPECIFICATION: remove redirect indicators, use autolinks #12133

Merged
merged 6 commits into from
Feb 19, 2024
Merged

CLIENT-SPECIFICATION: remove redirect indicators, use autolinks #12133

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ab36e1f
CLIENT-SPECIFICATION: remove redirect indicators, use autolinks
sbrl Jan 24, 2024
138850b
CLIENT-SPECIFICATION: Update changelog
sbrl Jan 24, 2024
22bcf73
CLIENT-SPECIFICATION: wording
sbrl Jan 26, 2024
0065e15
CLIENT-SPECIFICATION: add e.g.
sbrl Jan 26, 2024
fb4a2bd
CLIENT-SPECIFICATION/caching: Add example to language code
sbrl Feb 6, 2024
78cedd3
Merge branch 'main' into client-spec-redirects
kbdharun Feb 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion CLIENT-SPECIFICATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ Step | Path checked | Outcome

## Caching

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://tldr.sh/assets/tldr.zip](https://tldr.sh/assets/tldr.zip)** (Which redirects to [https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr.zip](https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr.zip)) or download language-specific translation archives in the format `https://tldr.sh/assets/tldr-pages.{{language-code}}.zip` (Which redirects to [https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr-pages.{{language-code}}.zip](https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets)), along with the archive for English from **[https://tldr.sh/assets/tldr-pages.zip](https://tldr.sh/assets/tldr-pages.zip)** (It redirects to [https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr-pages.zip](https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr-pages.zip)).
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://tldr.sh/assets/tldr.zip>** or download language-specific archives in the format `https://tldr.sh/assets/tldr-pages.{{language-code}}.zip` (e.g. the English archive can also be downloaded from **<https://tldr.sh/assets/tldr-pages.zip>**).
kbdharun marked this conversation as resolved.
Show resolved Hide resolved
kbdharun marked this conversation as resolved.
Show resolved Hide resolved
sbrl marked this conversation as resolved.
Show resolved Hide resolved

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.

Expand All @@ -232,6 +232,7 @@ the commit hash changes when merging with squash or rebase.
-->

- Unreleased
- Removed redirect text from the [caching section](#caching)

- [v2.1, November 30th 2023](https://github.com/tldr-pages/tldr/blob/v2.1/CLIENT-SPECIFICATION.md) ([#11523](https://github.com/tldr-pages/tldr/pull/11523))
- Add requirement to support escaping the placeholder syntax in certain pages ([#10730](https://github.com/tldr-pages/tldr/pull/10730))
Expand Down