Draggable: [DOCS] Documentation on the main website was outdated

[psociety]

1. Description

Distance option is not working/ignored. You can input any number and will start right away :S

EDIT: The issue was occurring because used the old CDN link which got on the main website

2. Example

https://jsfiddle.net/09L34vzt/1/

3. Specs:

• Library version: 1.0.0-beta.6 CDN
• Browsers: Chrome v85.0.4183.102 (64 bits) (Windows)
• Tech stack: [ES6/7 | ES5]

By the way, issue template talks about "_Select appropriate label in right sidebar..._", when there's no sidebar for normal users when creating it.

[bahung1221]

Hi, distance option was added on version 1.0.0-beta.10, so please migrate to beta-10 and then try it again. https://jsfiddle.net/v5nzbxdy/

BTW, we also have an issue with delay option on beta-11, which will be release soon, so just migrate to beta-10 to avoid that issue (if you needed delay option).

Thanks.

[bahung1221]

Feel free to ask if you have any question, thank you so much 😄

[psociety]

Wow facepalm, i'm truly sorry @bahung1221 . I swear i got the cdn url from official page, so i thought i had the very latest version. I will try to exactly find from where :(

Edit: https://shopify.github.io/draggable/

[bahung1221]

Oh I see, please use the docs on this repo instead of the docs on the main website (github page), it was outdated.
Unfortunately, I don't have access to the main website. So I will edit the title & re-open this issue.

@beefchimi , sorry for troubling you, but may you help us to update the main website documentation when you have rest time? Since it is outdated a lot and could create some unexpected issues for developers. I think we can temporarily link the documentation to github repo until we updated the main website 😄

[beefchimi]

👋 Howdy! @bahung1221 just to make sure, you want me to change the url on this link:

To link to the repo's main README.md, correct?

If so, I will see about pulling that off on the weekend perhaps.

[bahung1221]

Yes, that's right! Thank you so much 🎉

[beefchimi]

I did not get a chance to do this over the weekend... I will try and tackle this over (Canadian) Thanksgiving.

[psociety]

Will i be able to eat your thanksgiving food while you tackle this? I don't know what canadians eat for those dates. Do you also kill a turkey and eat it like americans? Mmm or as canadians you politely ask them for a slice of their own meat?

[beefchimi]

The tradition is to eat beaver tail, which is delivered at night by Canada Post and dropped down your chimney. Everyone takes turns apologizing to each other before beginning the feast. I would gladly save you some and ship it to your home address, but I can't imagine there will be any left overs.

We are all incredibly sorry. Please accept my apology on behalf of Canada.

[psociety]

[user72356]

I'm not sure I'm following the conversation entirely. Are you saying that the documentation at:

https://shopify.github.io/draggable/docs](https://shopify.github.io/draggable/docs

Is outdated and will no longer be updated? It looks like something that was auto-generated from source. Should that be generated against the latest codebase or simply removed?

I'm asking because I was about to report that some of the Droppable Events (for example), point to a 404 error:

https://shopify.github.io/draggable/docs/identifiers.html#droppable-droppableevent

The DroppableStartEvent and DroppableStopEvent docs specifically. Interestingly they are also missing from the README.md files in the repo. So I'm not too sure which doc to follow/trust? README.md or the auto-generated docs?

[bahung1221]

Hi @user72356 , sorry for this inconvenience.

The documentation on the main website (https://shopify.github.io/draggable/docs) was outdated a lot since the last version it was generated is 1.0.0-beta.6.
So please use the documentation on github repo instead.

In the future, the documentation main website will be temporarily hidden until it was re-generated with the latest version.

Thanks 😄

[bahung1221]

By the way, the DroppableStartEvent and DroppableStopEvent that you mentioned above aren't missing on the github repo documentation. It's here

[user72356]

By the way, the DroppableStartEvent and DroppableStopEvent that you mentioned above aren't missing on the github repo documentation. It's here

But it's missing from https://github.com/Shopify/draggable/tree/master/src/Droppable

That's a discrepancy and it's less likely that people will click the DroppableEvent subfolder, because most will trust the doc on the main Droppable page I'm sure! I know I did until I discovered it was missing events!

[bahung1221]

Ops 😨 you're right.
it's was missing on the Droppable main page, I will check and update missed stuff this weekend

Sorry again 😄

[beefchimi]

So I spent some time and bumped all the dependencies in both /examples and the homepage.

After rebuilding everything for production, I pushed up the changes to the gh-pages branch... but I've refrained from changing the documentation link just yet. I've rebuilt the /docs folder using our esdocs config and I'm hoping this has regenerated with the expected documentation? I know that when Tsov was authoring the library, we was commenting everything in a specific format to be compatible with esdocs so that it auto-generates good documentation.

Can someone let me know if it all looks legit? If its messed up / missing documentation, then I'll just go back and fix that one link.

[bahung1221]

Thanks @beefchimi , 🎉

It seems that the two documentations have different purpose, the one on the main website is API Docs and another one on github is usage docs.

I close this issue now, feel free to ask if you have any problems 😄