Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create READMEs for each package #252

Open
sohkai opened this issue Feb 28, 2019 · 2 comments
Open

Create READMEs for each package #252

sohkai opened this issue Feb 28, 2019 · 2 comments
Labels
documentation tech debt Technical issues caused by previously taken shortcuts

Comments

@sohkai
Copy link
Contributor

sohkai commented Feb 28, 2019

No description provided.

@sohkai sohkai added documentation tech debt Technical issues caused by previously taken shortcuts labels Feb 28, 2019
@2color
Copy link
Contributor

2color commented Mar 5, 2019

What information do we want in each README, especially given that the docs live elsewhere?

It's important to mention these READMEs will be shown in the package page on npm, e.g. https://www.npmjs.com/package/@aragon/wrapper

@sohkai
Copy link
Contributor Author

sohkai commented Mar 5, 2019

I think a basic description of what the package is for and why someone would care about them. Linking to the live docs website would be nice :).

We should steal as much as we can from how aragonUI has done it 😄 : https://github.com/aragon/aragon-ui/blob/master/README.md

@stale stale bot added the abandoned label Sep 1, 2019
@aragon aragon deleted a comment from stale bot Sep 1, 2019
@stale stale bot removed the abandoned label Sep 1, 2019
@stale stale bot added the abandoned label Feb 28, 2020
@aragon aragon deleted a comment from stale bot Feb 28, 2020
@stale stale bot removed the abandoned label Feb 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation tech debt Technical issues caused by previously taken shortcuts
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@2color @sohkai