Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Javascript SDK documentation #1001

Open
RichardJECooke opened this issue Aug 18, 2022 · 3 comments
Open

Fix Javascript SDK documentation #1001

RichardJECooke opened this issue Aug 18, 2022 · 3 comments
Labels

Comments

@RichardJECooke
Copy link

Describe the bug

This page, https://dropbox.github.io/dropbox-sdk-js/, says that to use the Javascript SDK you just have to npm install --save dropbox. But this doesn't work. You also have to build the package, see #621.

However, you can't build this package unless you download the whole examples repository, https://github.com/dropbox/dropbox-sdk-js, and run npm run build. This makes the whole npm dropbox thing useless. It's better just to use the prebuilt file on a cdn. But this isn't explained on the documentation page either, you have to go look in github issues to find it.

Secondly, the dropbox-sdk-js page says after installation to follow examples, or read the documentation. But the link to "documentation" is just a recursive link back to the same installation page, https://dropbox.github.io/dropbox-sdk-js/! There is no documentation for this SDK at all.

This page is just a big mess for new users and needs to be fixed please. Someone at Dropbox needs to take a fresh virtual machine, follow the instructions given on the page, and update where necessary to see how an actual outside user will encounter problems when trying to follow your instructions, and then update the documentation to something that works.

@greg-db
Copy link
Contributor

greg-db commented Aug 18, 2022

Thanks for the feedback! I'm sending it along to the team.

The examples included with SDK reference a locally built version of the library so the build instructions are necessary to run those as-is, but for your own node app(s) can import a copy of the library installed using npm install, or for browser apps from a JS CDN as you mentioned, without downloading and building it locally from the source here.

Also, regarding the documentation page, you can use the "Classes" and "Global" menus at the top of the page to access the documentation for the specific classes and methods.

@timrobinson33
Copy link

Wow I never would have spotted the "Classes" and "Global" menus. you should definitely redesign the page to make them more obvious (maybe just getting rid of the huge extraneous image would help)

@greg-db
Copy link
Contributor

greg-db commented Jun 7, 2023

@timrobinson33 Thanks for the note!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants