ipfs-docs icon indicating copy to clipboard operation
ipfs-docs copied to clipboard
verified publisher icon ipfs

docs: mention kubo-rpc-client

Open SgtPooki opened this issue 3 years ago • 3 comments

Tracking issue: https://github.com/ipfs/js-kubo-rpc-client/issues/36 Parent issue: https://github.com/ipfs/js-kubo-rpc-client/issues/6 Originating issue: https://github.com/ipfs/kubo/issues/9125

This PR is intended to update the docs so that users will be pointed to kubo-rpc-client instead of ipfs-http-client when using Javascript/TypeScript to talk to Kubo.

fixes https://github.com/ipfs/js-kubo-rpc-client/issues/36

Things for reviewers to check:

  1. Confirm I didn't miss any areas that should be updated (old mentions that should be updated that aren't yet)
  2. Confirm the added information is accurate and desired
  3. Confirm that the language used is aligned with maintainers' intentions

SgtPooki avatar Oct 05 '22 21:10 SgtPooki

Thank you for submitting this PR! A maintainer will be here shortly to review it. We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned.
  • Your contribution itself is clear (grammar and spelling checked, any code blocks checked and commented) and in its best form. Follow the docs contribution guidelines if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment. Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on any missing things and potentially assigning a reviewer for high priority items.
  • The PR gets reviews, discussed and approvals as needed.
  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution. We are very grateful for your contribution!

welcome[bot] avatar Oct 05 '22 21:10 welcome[bot]

We shouldn't block, but I added @achingbrain .

I also put the IPFS doc writer: @TMoMoreau .

BigLep avatar Oct 05 '22 22:10 BigLep

@TMoMoreau ready to merge after CI passes if you're good with the changes requested by lidel that I've addressed.

SgtPooki avatar Oct 12 '22 22:10 SgtPooki

@TMoMoreau / @SgtPooki : lets get this merged :)

BigLep avatar Oct 17 '22 18:10 BigLep

@SgtPooki left a minor suggestion

salmad3 avatar Oct 19 '22 14:10 salmad3

Thanks for pushing this over the line @DannyS03, the last few weeks have been wild

SgtPooki avatar Nov 10 '22 17:11 SgtPooki