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.

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

Improve library description and details #2

Open
edrpls opened this issue Mar 29, 2018 · 9 comments
Open

Improve library description and details #2

edrpls opened this issue Mar 29, 2018 · 9 comments
Assignees

Comments

@edrpls
Copy link

edrpls commented Mar 29, 2018

There are a few improvements we could add to the library details:

  • Add license type to generated build package.json
  • Copy license.txt to the build on tools/build.js
  • Improve library description
  • Clarify difference between DS documentation and Storybook
  • the examples are all using yarn, but clarify or add a note, that you can also use npm
  • show an example of a full component in the "using" section. right now we only show how to import a component
  • update git flow section to add the -k flag when finishing
    Please comment this ticket with any other improvements for this version.
@edrpls edrpls self-assigned this Mar 29, 2018
@jscottsmith
Copy link
Contributor

Not related to a release, but we should also add the storybook link next to the Github description:

screen shot 2018-03-29 at 4 39 09 pm

@edrpls
Copy link
Author

edrpls commented Mar 29, 2018

@jscottsmith for sure, actually, if it's not tied to the code, would you mind adding it?

@jscottsmith
Copy link
Contributor

I can't edit those details, I think I need permissions.

@edrpls
Copy link
Author

edrpls commented Mar 29, 2018

Oh... Nevermind then. I'll see if I can edit them.

@mnicole
Copy link
Collaborator

mnicole commented Mar 29, 2018

i think we need to get permissions from ken or someone... i wanted to add some labels and couldn't.

@edrpls
Copy link
Author

edrpls commented Mar 29, 2018

@mnicole makes sense, I don't even see the options @jscottsmith shared. Paging @kweiner.

@mnicole
Copy link
Collaborator

mnicole commented Mar 29, 2018

also:

  • the examples are all using yarn, but clarify or add a note, that you can also use npm
  • show an example of a full component in the "using" section. right now we only show how to import a component

@edrpls
Copy link
Author

edrpls commented Mar 29, 2018

uh... Nevermind, I was able to change the website URL, I guess we just need permissions for the labels then.

@mnicole thanks for the suggestions, I'll add it to my original comment.

@mnicole
Copy link
Collaborator

mnicole commented Mar 29, 2018

@kweiner is it possible to add @jscottsmith as a member of 'gumgum' and to give us all more permissions for this repo? thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants