Skip to content

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

Compare
Choose a tag to compare
@kbdharun kbdharun released this 10 Sep 17:47
· 3999 commits to main since this release
v2.0
ebd4b32

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 (#7514) (thanks @MasterOdin)
  • Drop the special "all" platform from the --list flag (#7561) (thanks @dbrgn)
  • Drop the master branch from the assets link. (#9668) (thanks @MasterOdin)
  • Require support for long options (#9651) (thanks @pixelcmtd)
  • Add recommendation to support caching 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

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.