dataverse-client-javascript icon indicating copy to clipboard operation
dataverse-client-javascript copied to clipboard

docs: use relative links in README.md instead of absolute GitHub blob URLs

Open Copilot opened this issue 1 month ago • 0 comments

What this PR does / why we need it:

Replaces absolute GitHub blob links pointing to main branch with relative paths so links resolve to the current branch context (e.g., develop, feature branches).

Changes:

  • https://github.com/IQSS/dataverse-client-javascript/blob/main/docs/useCases.mddocs/useCases.md
  • https://github.com/IQSS/dataverse-client-javascript/blob/main/docs/usage.mddocs/usage.md
  • https://github.com/IQSS/dataverse-client-javascript/blob/main/CHANGELOG.mdCHANGELOG.md
  • https://github.com/IQSS/dataverse-client-javascript/blob/main/CONTRIBUTING.mdCONTRIBUTING.md
  • https://github.com/IQSS/dataverse-client-javascript/blob/main/LICENSELICENSE

Which issue(s) this PR closes:

closes #400

Related Dataverse PRs:

  • N/A

Special notes for your reviewer:

Verify links work correctly when viewing README.md from different branches (e.g., develop, main).

Suggestions on how to test this:

Navigate to this PR's branch on GitHub and click the documentation links in README.md to confirm they resolve to files in the same branch rather than main.

Is there a release notes or changelog update needed for this change?:

No - documentation-only change with no user-facing impact.

Additional documentation:

N/A

Original prompt

Change absolute GitHub blob links in README.md to relative links so they resolve to the correct version on the branch being viewed (e.g., develop).

Files to change:

  1. README.md (path: README.md)
  • Replace the following absolute links that point to the main branch with relative links so GitHub will resolve them to the current branch:
    • https://github.com/IQSS/dataverse-client-javascript/blob/main/docs/useCases.md -> docs/useCases.md
    • https://github.com/IQSS/dataverse-client-javascript/blob/main/docs/usage.md -> docs/usage.md
    • https://github.com/IQSS/dataverse-client-javascript/blob/main/CHANGELOG.md -> CHANGELOG.md
    • https://github.com/IQSS/dataverse-client-javascript/blob/main/CONTRIBUTING.md -> CONTRIBUTING.md
    • https://github.com/IQSS/dataverse-client-javascript/blob/main/LICENSE -> LICENSE

Provide the updated README.md content below (use this exact text as the replacement file contents):

## Dataverse JavaScript Client

![NPM Version](https://img.shields.io/npm/v/%40iqss%2Fdataverse-client-javascript)

The Dataverse JavaScript Client is an open-source package that provides a set of use-case-driven functions to interact with the [Dataverse API](http://guides.dataverse.org/en/latest/api/). Designed ar[...]

This package is part of the Dataverse Frontend ecosystem and is intended to be used by applications or services that integrate with the Dataverse platform.

## Features

- **Use case-centric API functions** – Organized around domain-specific actions like `getDataset`, `createCollection`, or `restrictFile`.
- **TypeScript-first** – All use cases include strong typings for inputs and outputs, improving developer experience.

## Installation

Install the package via npm:

```bash
npm install @iqss/dataverse-client-javascript
```

## Usage

```typescript
import { getDataset } from '@iqss/dataverse-client-javascript'

/* ... */

const datasetIdentifier = 'doi:10.77777/FK2/AAAAAA'
const datasetVersion = '1.0'

getDataset.execute(datasetIdentifier, datasetVersion).then((dataset: Dataset) => {
  /* ... */
})

/* ... */
```

For detailed information about available use cases see [Use Cases Docs](docs/useCases.md).

For detailed information about usage see [Usage Docs](docs/usage.md).

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for a detailed history of changes to this project.

## Contributing

Want to add a new use case or improve an existing one? Please check the [Contributing](CONTRIBUTING.md) section.

## License

This project is open source and available under the [MIT License](LICENSE).

Acceptance criteria:

  • Create a new branch off develop (branch name should be docs/readme-relative-links)
  • Commit the updated README.md to that branch
  • Open a pull request into develop with a descriptive title and body explaining the change

Please create the branch docs/readme-relative-links off develop, commit the change, and open the PR into develop. Do not add any other changes.

This pull request was created as a result of the following prompt from Copilot chat.

Change absolute GitHub blob links in README.md to relative links so they resolve to the correct version on the branch being viewed (e.g., develop).

Files to change:

  1. README.md (path: README.md)
  • Replace the following absolute links that point to the main branch with relative links so GitHub will resolve them to the current branch:
    • https://github.com/IQSS/dataverse-client-javascript/blob/main/docs/useCases.md -> docs/useCases.md
    • https://github.com/IQSS/dataverse-client-javascript/blob/main/docs/usage.md -> docs/usage.md
    • https://github.com/IQSS/dataverse-client-javascript/blob/main/CHANGELOG.md -> CHANGELOG.md
    • https://github.com/IQSS/dataverse-client-javascript/blob/main/CONTRIBUTING.md -> CONTRIBUTING.md
    • https://github.com/IQSS/dataverse-client-javascript/blob/main/LICENSE -> LICENSE

Provide the updated README.md content below (use this exact text as the replacement file contents):

## Dataverse JavaScript Client

![NPM Version](https://img.shields.io/npm/v/%40iqss%2Fdataverse-client-javascript)

The Dataverse JavaScript Client is an open-source package that provides a set of use-case-driven functions to interact with the [Dataverse API](http://guides.dataverse.org/en/latest/api/). Designed ar[...]

This package is part of the Dataverse Frontend ecosystem and is intended to be used by applications or services that integrate with the Dataverse platform.

## Features

- **Use case-centric API functions** – Organized around domain-specific actions like `getDataset`, `createCollection`, or `restrictFile`.
- **TypeScript-first** – All use cases include strong typings for inputs and outputs, improving developer experience.

## Installation

Install the package via npm:

```bash
npm install @iqss/dataverse-client-javascript
```

## Usage

```typescript
import { getDataset } from '@iqss/dataverse-client-javascript'

/* ... */

const datasetIdentifier = 'doi:10.77777/FK2/AAAAAA'
const datasetVersion = '1.0'

getDataset.execute(datasetIdentifier, datasetVersion).then((dataset: Dataset) => {
  /* ... */
})

/* ... */
```

For detailed information about available use cases see [Use Cases Docs](docs/useCases.md).

For detailed information about usage see [Usage Docs](docs/usage.md).

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for a detailed history of changes to this project.

## Contributing

Want to add a new use case or improve an existing one? Please check the [Contributing](CONTRIBUTING.md) section.

## License

This project is open source and available under the [MIT License](LICENSE).

Acceptance criteria:

  • Create a new branch off develop (branch name should be docs/readme-relative-links)
  • Commit the updated README.md to that branch
  • Open a pull request into develop with a descriptive title and body explaining the change

Please create the branch docs/readme-relative-links off develop, commit the change, and open the PR into develop. Do not add any other changes.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot avatar Nov 14 '25 17:11 Copilot