IQSS / IQSS/dataverse-client-javascript

Create documentation for the installation and use of the package v2

Open
#73 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

pm.GREI-d-2.7.1 pm.GREI-d-2.7.2 Size: 33
Dominant language
TypeScript
Stars
20
Forks
11
Avg merge
2d 5h
Merged PRs (30d)
1

Description

Overview of the feature request

This documentation should contain topics such as the installation of the package through NPM, the initialization via ApiConfig, and instructions for importing and executing its use cases.

What inspired the request?

  • Latest changes on the package and upcoming release

What existing behavior do you want changed?

None

Any brand new behavior do you want to add to js-dataverse?

None

Any open or closed issues related to this feature request?

None

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin by reviewing the package's NPM installation flow and ApiConfig initialization, then trace the documented import and use-case execution path. The work is done when documentation covers installation, initialization, importing, and executing use cases for package v2.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.