New documentation for js-dataverse v2#118
Merged
Conversation
… into 113-documentation-v2
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
…rse-client-javascript into 113-documentation-v2
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
…nloadSize Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
Co-authored-by: Ellen Kraffmiller <ekraffmiller@hmdc.harvard.edu>
…rse-client-javascript into 113-documentation-v2
… into 113-documentation-v2
ekraffmiller
approved these changes
Feb 23, 2024
Contributor
|
LGTM! For future iterations, I would suggest adding a "Go Back to Index" button on all the documentation pages, as it can be frustrating trying to navigate back to the index |
MellyGray
approved these changes
Feb 23, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Adds updated and structured documentation to the package, for its next release to version 2.
The docs include a section dedicated to use cases, which includes a description and example calls for each of the use cases available in the package.
Which issue(s) this PR closes:
Related Dataverse PRs:
Special notes for your reviewer:
Suggestions on how to test this: