Client specification v2.0: Introducing individual translation archives for caching and other changes

[kbdharun]

Calling all maintainers of both clients and tldr alike!

Since the v1.5b release, the master branch was removed. The clients that haven't updated got moved to a dedicated section in the wiki. If you are a user of any of these clients, we highly recommend migrating to a supported community client or one of our official clients.

Client authors

Changelog

This version of the CLIENT SPECIFICATION introduces the following changes:

• Add recommendation to support macos alias for osx (CLIENT-SPECIFICATION: add macos recommendation #7514) (thanks @MasterOdin)
• Drop the special "all" platform from the --list flag (CLIENT-SPECIFICATION: drop the special "all" platform #7561) (thanks @dbrgn)
• Drop the master branch from the assets link. (CLIENT-SPECIFICATION: Use main for asset link #9668) (thanks @MasterOdin)
• Require support for long options (CLIENT-SPECIFICATION: Require support for long options #9651) (thanks @pixelcmtd)
• Add recommendation to support caching individual translation archives (CLIENT-SPECIFICATION (2.0): document removal of master branch, addition of support for individual translation archives #10148) (thanks @kbdharun)

Requiring support for long options

Clients will be required to add support for long options for commands along with short options for a more uniform experience.

Introducing caching support for individual translation archives for each language

Addressing the community's requests, we have added support for individual language-specific translation archives in #10555 (thanks @adamazing). If your client displays pages based on the user's language configuration from the cache, now you can include the selected language along with English as a fallback to save space from unused languages.

Complete translation archives will still be available for clients using it.

tldr maintainers

Dependabot alerts and CodeQL analysis got enabled on compatible repositories org-wide.

Community updates

• The primary chatroom address has been updated to #tldr-pages:matrix.org. The old Gitter chatroom address was added as an alternate published address.
• Last year, we faced an incident with the CLA [bot], where we fixed the title of our project in the GitHub Gist that invalidated any previously signed CLAs of existing contributors. We are sorry for the inconvenience caused, and we suggest resigning the CLA when you contribute again.
• The domain https://tldr.sh has been verified in the tldr-pages GitHub organization. (thanks @agnivade)
• We are now on Fediverse. We have created a new account on Fosstodon (A @mastodon instance for FOSS projects). Feel free to check out https://fosstodon.org/@tldr_pages. (thanks @sbrl)
• The live demo web client on the official website has been updated (Update live demo url to tldr.inbrowser.app tldr-pages.github.io#65) to use https://tldr.inbrowser.app. (thanks @rwv)
• Introducing the new Snap package for our Python client. (thanks @soumyaDghosh)
• We have added featured information to the tldr and tldr-pages topics on GitHub. (thanks @kbdharun)
• New maintainers and members got added with other role transitions, check out MAINTAINERS.md for more information.

Last year's Hacktoberfest was one of the biggest for tldr-pages, with more than 700 PRs merged from 240+ contributors🎉 . We are excited for this year's Hacktoberfest next month.

Thanks to all the contributors and maintainers for their contributions.

---

This discussion was created from the release Client specification v2.0: Introducing individual translation archives for caching and other changes.