cassette icon indicating copy to clipboard operation
cassette copied to clipboard

Need help with documentation

Open benwiley4000 opened this issue 7 years ago • 1 comments
trafficstars

I've put together a new interactive documentation site with examples for the 2.0 alpha: https://benwiley4000.github.io/cassette/styleguide/

However there are many outstanding issues:

  • We don't have descriptions for any prop types
    • These are added by including /** Prop type description */ comments above propType definitions
  • We are missing examples for some components
    • These are defined in the docs directories of each package
  • We need some type descriptions for things like playlist track
    • /packages/core/docs/Types.md
  • Other miscellaneous cleanup

Also I would like some more complex standalone examples demonstrating how to emulate the UI of various popular media player interfaces with cassette, e.g. YouTube, Vimeo, Spotify.

I'd really appreciate any Hacktoberfesters who would feel generous enough to contribute documentation pull requests in any form or quantity. Please reach out if you have questions!

benwiley4000 avatar Oct 15 '18 15:10 benwiley4000

Documentation should be updated to specifically take into account feedback from alpha users.

benwiley4000 avatar Dec 04 '18 04:12 benwiley4000