Skip to content
This repository has been archived by the owner on Oct 25, 2021. It is now read-only.

Documentation: Polkadot UI #34

Closed
EdwardAThomson opened this issue Aug 29, 2018 · 10 comments
Closed

Documentation: Polkadot UI #34

EdwardAThomson opened this issue Aug 29, 2018 · 10 comments
Labels
Bounty This issue has a bounty to be won! Development: General Component Development - General ecosystem component requires development

Comments

@EdwardAThomson
Copy link
Contributor

EdwardAThomson commented Aug 29, 2018

Documentation: Polkadot UI

Create documentation for Polkadot APIs used by the Polkadot-js UI!

Description
There is a clear need for better documentation around the Polkadot platform. One area that would be a good first place to start is around the APIs for the Polkadot user interface, and in particular how this pertains to enabling integration with wallet products.

In addition to documentation, we are looking to collaborate with teams on building wallets:
#10.

Requirements: a correct submission will:

  • provide examples
  • write a tutorial that makes use of a meaningful number of API methods

Gitcoin

We have put up a bounty on Gitcoin. This is a cooperative bounty, and we will reward up to 3 quality submissions with Ether.

Please see:

This issue now has a funding of 1.28 ETH (293.72 USD @ $229.47/ETH) attached to it.

@EdwardAThomson EdwardAThomson added Development: General Component Development - General ecosystem component requires development Ecosystem: Polkadot labels Aug 29, 2018
@navp4l
Copy link

navp4l commented Sep 1, 2018

@EdwardAThomson @jplatts12 I've started working on this - https://github.com/palanisn/api. First commit with updated README for api-provider package - https://github.com/palanisn/api/blob/master/packages/api-provider/README.md. Any feedback is appreciated.

@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


This issue now has a funding of 1.28 ETH (293.72 USD @ $229.47/ETH) attached to it.

@jplatts12
Copy link
Contributor

jplatts12 commented Sep 6, 2018

This issue is now up for bounty with Gitcoin!

This is a cooperative bounty, and we will reward up to 3 quality submissions with Ether.

-Web3 Foundation Team

@gitcoinbot
Copy link

gitcoinbot commented Sep 6, 2018

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work has been started.

These users each claimed they can complete the work by 11 months, 1 week from now.
Please review their action plans below:

1) chevdor has started work.

Hi there, I will give it a go and see if I can put together something useful that can grow with the API.

Learn more on the Gitcoin Issue Details page.

@jplatts12
Copy link
Contributor

@EdwardAThomson @jplatts12 I've started working on this - https://github.com/palanisn/api. First commit with updated README for api-provider package - https://github.com/palanisn/api/blob/master/packages/api-provider/README.md. Any feedback is appreciated.

Make sure to add your work to the Gitcoin bounty! @palanisn

@EdwardAThomson EdwardAThomson added the Bounty This issue has a bounty to be won! label Sep 13, 2018
@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work for 1.28 ETH (271.54 USD @ $212.14/ETH) has been submitted by:

  1. @chevdor

@jplatts12 please take a look at the submitted work:


@ltfschoen
Copy link

@palanisn The README file at https://github.com/polkadot-js/api/tree/master/docs/api-provider just contains description and usage, the rest is now in sub-folders. It is published here https://github.com/polkadot-js/api/tree/master/docs/api-provider

@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


The funding of 1.28 ETH (289.64 USD @ $226.28/ETH) attached to this issue has been approved & issued to @chevdor.

@navp4l
Copy link

navp4l commented Oct 3, 2018

Good work @chevdor! Sorry about the delay in responding, was away on vaca.

@EdwardAThomson
Copy link
Contributor Author

Sorry about the delay in responding, was away on vaca.

We still have the bounty open for a couple more submissions! @palanisn

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Bounty This issue has a bounty to be won! Development: General Component Development - General ecosystem component requires development
Projects
None yet
Development

No branches or pull requests

5 participants