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.

Sign up for GitHub

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

Jump to bottom

Links in the README on request docs are dead. #205

Open

SvendDomdey opened this issue Nov 22, 2024 · 0 comments

SvendDomdey commented Nov 22, 2024

The links in the README on the API docs are mostly dead. For example
https://github.com/emartech/suite-js-sdk?tab=readme-ov-file#create-6
https://github.com/emartech/suite-js-sdk?tab=readme-ov-file#listing-available-fields

Even worse, the dead links point to different documentation systems so there is a high risk of inconsistencies in the docs.

Open README
Click one of the link in SDK methods(https://github.com/emartech/suite-js-sdk?tab=readme-ov-file#sdk-methods)

Context (Environment)

Increases the burden to consume the Suite JS SDK. Particularly unfortunate for internal consumers.

It would be great if you can have a look and update the docs.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment