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

Every Module Should Have a Demo. #164

Closed
5 of 8 tasks
gauntface opened this issue Jan 20, 2017 · 7 comments
Closed
5 of 8 tasks

Every Module Should Have a Demo. #164

gauntface opened this issue Jan 20, 2017 · 7 comments

Comments

@gauntface
Copy link

gauntface commented Jan 20, 2017

This is a checklist of things missing from current docs.

  • Every module has a demo.
    • Add some styles to demos.
    • Make it more evident as to what the demo is showing off.
  • Every module has a description for the module in JSDocs.
  • Every module has some JSDoc OR we have some markdown file introducing each project.
  • Add examples to every method.
  • Add Example of public constructor.
  • Add fuller examples on each index.
@gauntface
Copy link
Author

cc @jpmedley I'll go through this with you sometime next week to get your thoughts / input on this as well as how to use npm-publish-scripts (if you are interested).

@jpmedley
Copy link
Contributor

"how to use npm-publish-scripts (if you are interested)." Never ask if I'm interested. Ask when I have the time.

@prateekbh
Copy link
Collaborator

@gauntface current JSDocs also $0 thingy, after every parameter. May be we can cover to remove them as well
e.g. https://github.com/GoogleChrome/sw-helpers/tree/master/packages/sw-background-sync-queue#constructor

@gauntface
Copy link
Author

@prateekbh what is the $0 thingy you are referring to?

@addyosmani addyosmani modified the milestone: Service Worker Framework (beta) Feb 17, 2017
@addyosmani
Copy link
Member

I have an issue for migration docs tracked at #109 - should this be folded in here or best to keep that separate?

@gauntface gauntface changed the title Doc Needs. Every Module Should Have a Demo. Mar 3, 2017
@gauntface
Copy link
Author

@addyosmani Keep it seperate for now - I've change the title for this to just cover Demos.

@gauntface gauntface removed this from the Service Worker Framework (alpha) milestone Mar 10, 2017
@jpmedley jpmedley removed their assignment Mar 10, 2017
@gauntface
Copy link
Author

Going to close this - demo's still need some love, but can be done if and when we feel it's important

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

No branches or pull requests

4 participants