Skip to content

Update README.md#89

Merged
michaelmang merged 7 commits intomasterfrom
documentation
May 18, 2020
Merged

Update README.md#89
michaelmang merged 7 commits intomasterfrom
documentation

Conversation

@michaelmang
Copy link
Contributor

@michaelmang michaelmang commented May 15, 2020

Adds some basic documentation for the package.

When we open up outside contribution, we can update the readme accordingly.

@netlify
Copy link

netlify bot commented May 15, 2020

Deploy preview for helix-react ready!

Built with commit 83a356f

https://deploy-preview-89--helix-react.netlify.app

Copy link
Contributor

@nicko-winner nicko-winner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great jobs with the docs! added a few suggestions

michaelmang and others added 3 commits May 15, 2020 15:47
Co-authored-by: Nicko Winner-Arroyo <35456401+nicko-winner@users.noreply.github.com>
Co-authored-by: Nicko Winner-Arroyo <35456401+nicko-winner@users.noreply.github.com>
@michaelmang
Copy link
Contributor Author

@nicko-winner feedback addressed, ready for a re-review

README.md Outdated
For questions related to using the library, please visit a support community
instead of filing an issue on GitHub.

[Slack](https://join.slack.com/share/zt-edajgkat-LG_5SXYoCeIzknrQPVWaTA)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a policy around making a publicly accessible channel? or only rackers can access this channel?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You bring up a good point about a publicly accessible channel.

External contributors will have to submit an issue. We can make an announcement internally on Slack when we're ready to go live.

Copy link
Member

@100stacks 100stacks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great...just a few small changes.

README.md Outdated
```bash
npm start
```
The script should automatically open Storybook in your browser, but you can always navigate to http:http://localhost:6006/?path=/story
Copy link
Member

@100stacks 100stacks May 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the extra http:.

Also put the link in backticks, so that it's not a live link.

http://localhost:6006/?path=/story

README.md Outdated
For questions related to using the library, please visit a support community
instead of filing an issue on GitHub.

[Slack](https://join.slack.com/share/zt-edajgkat-LG_5SXYoCeIzknrQPVWaTA)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You bring up a good point about a publicly accessible channel.

External contributors will have to submit an issue. We can make an announcement internally on Slack when we're ready to go live.

README.md Outdated
<table>
<tr>
<td align="center"><a href="https://github.com/michaelmang"><img src="https://avatars0.githubusercontent.com/u/10120600?s=400&u=7a37b1eba79b6ee2c7753a457b8a33998595fe20&v=4" width="100px;" alt=""/><br /><sub><b>James Thompson</b></sub></a><br /><a href="https://github.com/HelixDesignSystem/helix-react/commits?author=100Stacks" title="Commits">💻</a></td>
<td align="center"><a href="https://github.com/michaelmang"><img src="https://avatars0.githubusercontent.com/u/35456401?s=400&v=4" width="100px;" alt=""/><br /><sub><b>Nicko Winner-Arroyo</b></sub></a><br /><a href="https://github.com/HelixDesignSystem/helix-react/commits?author=nicko-winner" title="Commits">💻</a></td>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the link:

<a href="https://github.com/nicko-winner">

README.md Outdated

<table>
<tr>
<td align="center"><a href="https://github.com/michaelmang"><img src="https://avatars0.githubusercontent.com/u/10120600?s=400&u=7a37b1eba79b6ee2c7753a457b8a33998595fe20&v=4" width="100px;" alt=""/><br /><sub><b>James Thompson</b></sub></a><br /><a href="https://github.com/HelixDesignSystem/helix-react/commits?author=100Stacks" title="Commits">💻</a></td>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update the link:

<a href="https://github.com/100stacks">

README.md Outdated
![helix-ui-documentation](https://user-images.githubusercontent.com/22566333/82083617-07f70700-96b8-11ea-9581-da1796737e52.png)

These components are just the "building blocks" of other Helix patterns listed in
the [Helix design documentation](http://helix.rax.io/status.html).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That list is a little dated. Let's not link to it please.

@michaelmang
Copy link
Contributor Author

@100stacks this is ready for re-review

Copy link
Member

@100stacks 100stacks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hit the wrong button 🤦

Copy link
Member

@100stacks 100stacks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job!

Dev LGTM

@michaelmang michaelmang merged commit efd9873 into master May 18, 2020
@michaelmang michaelmang deleted the documentation branch May 18, 2020 17:02
@100stacks 100stacks added this to the v1.0.0-rc.0 milestone Jul 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants