Storybook Documentation

[villanuevawill]

This is an advanced task and we are only accepting candidates who have time, resources, and bandwidth to put significant time into this.

Update components in storybook to display beautifully and match the quality of documentation that is currently in the Text and Button component.

This is a pretty big task and requires getting intimate and creative with the storybook documentation. We'd like to generally follow the current format in Button and Text component. We'd also like to add components from the root components that are not yet in storybook. yarn storybook to get things running.

Requirements

• Document any missing components from the root components root components
• Bring all components on storybook to follow the standard in Button and Text
• Be creative - get to know the actual components and make sure the major props are documented (a lot of what is up there needs way more of the current usecases posted). Meaning you should not just take what is already there and update it with the new format. this is MUCH MORE INVOLVED than that
• This task is only for rockstars

Communication

• Join our slack community and message in our community-dev channel for questions
• Put a PR up directly into the explorer repo

[gitcoinbot]

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

---

This issue now has a funding of 2.0 ETH (453.34 USD @ $226.67/ETH) attached to it as part of the Bounties Network fund__.__

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $43,484.13 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

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

---

Work has been started.

These users each claimed they can complete the work by 4 months, 2 weeks ago.
Please review their action plans below:

1) zerquix18 has been approved to start work.

I already downloaded the repository and played around with it. I'll make the changes locally, creating one commit per component documented. In addition, I can upload the changes to a private repository and add the maintainers so they can see the progress and ask for changes or notify me about anything wrong. In the end I'll fork the original one and create a pull request :)

Learn more on the Gitcoin Issue Details page.

2) rahulrumalla has applied to start work (Funders only: approve worker | reject worker).

Overview - implement stories docs for all the components present under the /src/stories/ folder. Cross-check if all root components are indeed present in the stories folder, if not add and document them. Use Button.stories.js and Text.stories.js as inspiration.

Keen attention needs to be paid to some of props and bring the user's attention highlighting the behavior applied using the prop(s). I suspect this is where each story documentation is contextual to its respective component.

Work samples:

• Infura docs via GC bounty (https://infura.io/docs)
• Personal project in VueJS (github.com/musicallyuk/sandbox-web), heavily uses Vuetify which is a UI component framework. Very familiar with the docs and a huge fan of this --> vuetifyjs.com

Keen to start.

Learn more on the Gitcoin Issue Details page.

[villanuevawill]

@writeprovidence - thanks for applying to this. Do you have some examples of UI work you've done? Any opinions in general on component libraries, storybook, etc.?

[villanuevawill]

Also - Do you have the bandwidth to put time into this?

[villanuevawill]

@Zerquix18 same questions here for you.

[Zerquix18]

What kind of examples?

• Here's an example of my project in production, built on React.
• Here's an example of its root component.
• Here's a recent project built on Vue.js with Buefy's help
• Contribution to Bulma, including to its documentation

I think component libraries simplify a lot of work, as long as they're not too limited.

[villanuevawill]

@Zerquix18 awesome. I'm approving this right now :)

[gitcoinbot]

@Zerquix18 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

• warning (3 days)
• escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

[Zerquix18]

@Zerquix18 Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

• warning (3 days)
• escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

Yes! Actively working on it.

[gitcoinbot]

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

---

Work for 2.0 ETH (411.92 USD @ $205.96/ETH) has been submitted by:

1. @Zerquix18

@villanuevawill please take a look at the submitted work:

• (Link Not Provided) by @Zerquix18

---

• Learn more on the Gitcoin Issue Details page
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $51,353.86 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

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

---

The funding of 2.0 ETH (420.79 USD @ $210.4/ETH) attached to this issue has been approved & issued to @Zerquix18.

• Learn more on the Gitcoin Issue Details page
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $50,198.21 more funded OSS Work available on the Gitcoin Issue Explorer