General-grants-program: Documentation: Polkadot UI

Created on 29 Aug 2018  路  10Comments  路  Source: w3f/General-Grants-Program

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.__

General Component Bounty

Most helpful comment

@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.

All 10 comments

@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.

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.__

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

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.

@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

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:

  • PR by @chevdor

@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

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.__

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

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

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

Was this page helpful?
0 / 5 - 0 ratings

Related issues

dfishb picture dfishb  路  15Comments

EdwardAThomson picture EdwardAThomson  路  16Comments

EdwardAThomson picture EdwardAThomson  路  7Comments

ghuun picture ghuun  路  7Comments

EdwardAThomson picture EdwardAThomson  路  14Comments