guide
guide copied to clipboard
discordjs
please add API version
Is your feature request related to a problem? Please describe.
the library has many breaking changes between major versions, and I'm not sure what version these docs are based on. https://discordjs.guide/additional-info/changes-in-v14.html#before-you-start
Describe the solution you'd like
Please add a v13 or v14 etc to the footer or somewhere? I couldn't see it anywhere.
Describe alternatives you've considered
searching thru the repo to see a version somewhere, anywhere.
Additional notes
not sure how you would track old versions.
If you mean API version: it is handled internally and you don't often need to worry about it. v14 uses v10 of the API, and v13 uses v9 of the API. Otherwise, the guide is being updated to specifically show how to use v14, and v13 (which is still going to be maintained) is on a different subdomain: v13.discordjs.guide
yes actually I meant which version of the discordJS package/api is being shown. It's hard to know, esp when there are 14.0 versions out, it's not clear if updated yet.
also this might need to be more granular, eg most of the guide may be unchanged but it's not worth holding back the whole guide until everything is updated. So it could be "last updated at..." on a tree/branch/page/feature level of the docs? Hopefully your docbuilder has support for this. eg using docusaurus:
yes actually I meant which version of the discordJS package/api is being shown. It's hard to know, esp when there are 14.0 versions out, it's not clear if updated yet.
also this might need to be more granular, eg most of the guide may be unchanged but it's not worth holding back the whole guide until everything is updated. So it could be "last updated at..." on a tree/branch/page/feature level of the docs? Hopefully your docbuilder has support for this. eg using docusaurus:
Don't the guide pages already have last updated timestamps?
the main guide on https://discordjs.guide always reflects the latest stable version +- a few days to apply updates and changes accordingly, right now the docs are v14, if you want older major versions you need a subdomain like https://v13.discordjs.guide
yes there's a date, but that would require cross-referencing with the release dates of versions. also, there's often a lag. eg july means... which version? I'm not even sure if 14.x is GA currently or if the docs are still on 13.x
it seems like both are being updated as of this date https://github.com/discordjs/discord.js/tags
also this might need to be more granular, eg most of the guide may be unchanged but it's not worth holding back the whole guide until everything is updated
I heavily disagree with this. Introducing changes in some sections but not others (save the vXX-changes section, which we merge prematurely) introduces inconsistency. People do not expect to switch from a page and suddenly see a different version.
The library is on stable v14 now, v13 is still being maintained for a while and accepts backports. If sections are changed that apply to v13 (on the guide) they are also updated - not doing so at this stage would be a bad decision in our eyes.
When you visit for the first time after a major update you should be getting a banner at the bottom as well:
ok i probably missed that footer. you could just add it as a permanent footer? just v14 somewhere would be enough. I've been stumbling through an upgrade from 13->14 today and hitting various issues, esp since the docs are mostly JS and the TS is a bit more prickly.
If you are on v13.discordjs.guide you are using v13, else the latest version, not sure if im getting what's wrong
