Skip to content

The README documents wallet adapters twice #20

Description

@Abioladory123

Summary

The README has a Wallet Adapters heading inside the API Reference and a second,
separate Wallet Adapters section further down covering Freighter and xBull. A
reader hitting the first one has no idea a fuller treatment exists below.

Two sections with the same name also means updates land in one of them and not
the other, which is how they drift apart.

Acceptance criteria

  • The wallet adapter material appears once, in whichever position suits the
    document's flow.
  • Nothing unique to either section is lost in the merge.
  • Any internal links or the table of contents are updated to match.

Getting started

Fork this repository, clone your fork, and add this repo as upstream:

git clone https://github.com/<your-username>/novatip-sdk.git
cd novatip-sdk
git remote add upstream https://github.com/Novatip/novatip-sdk.git
npm install

Create a branch for this issue:

git checkout -b docs/dedupe-adapter-sections

Suggested commit message:

docs: merge the duplicated wallet adapter sections

Run npm run lint, npm run typecheck, and npm run build before pushing, then open a pull request from your fork against main and link this issue. See the contributing guide for the full workflow.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions