search

anoopengineer / tldr

Native binary client for the tldr project - https://github.com/tldr-pages/tldr
16 stars 2 forks source link

Use the new index.json file in favor of the deprecated pages/index.json #2

Open mebeim opened 5 years ago

mebeim commented 5 years ago

Hello, I'm from the tldr-pages/tldr repository, and I'm here to inform you that we recently changed the content of the ZIP archive your client relies upon. Here's a link to the merged PR: #2862.

Inside the generated ZIP archive, a new /index.json file has been created, to be used in favor of the now deprecated /pages/index.json file, as you can see here. Once all the clients are updated, or enough time has passed, we will completely remove the /pages/index.json file from the generated ZIP archive, and only keep the top-level /index.json.

If your client does not rely on the mentioned file to work, you can close this right away, sorry for the trouble! Otherwise, in order to support the upcoming change, this client should be updated to either:

  1. Use the index.json file served by the static site itself, that is: https://tldr.sh/assets/index.json.
  2. Or use the new top-level /index.json file inside the ZIP file served by the static site, which is: https://tldr.sh/assets/tldr.zip.

Once the above is taken care of, you can close this issue and your client will be marked as up to date in our tracking issue here. This change should be trivial, but if there's any problem, please do let me know.

Thank you for your work and time you put into creating this client and supporting the TLDR pages project!

sbrl commented 3 years ago

/cc @anoopengineer. This is the last client to be updated - all the others have been done :-)