reactcards icon indicating copy to clipboard operation
reactcards copied to clipboard

Milestones

Open jhicken opened this issue 8 years ago • 3 comments

Hey are there any milestone for this project I would be happy to contribute if I knew how to help. This seems like it would be very useful for a project i'm currently working on.

A few things I can thing of that would be awesome.

  1. Give the package a "main" field and export all necessary components and functions in said the main file.
  2. Document all exported components and functions (the whole api).
  3. Maybe some sort of webpack middleware integration?
  4. I would like to maybe see jsdoc or some other documentation standard integration to dump comments from a component into a card. (for now the markdown works... but its sub optimal)

I'm just throwing ideas out here because I didn't see any milestone.

jhicken avatar May 19 '16 01:05 jhicken

I like 4 a lot.

I would also like to add a few more ideas, specifically around applying support for a style.

  1. deeper/richer routing/namespace home/atoms/foo or home/molecules/forms/date-selector etc with associated improvements in navigation, perhaps like http://patternlab.io/
  2. Devcard discovery e.g. pointing at a folder, it then using devcard.js to find cards to include in the tree
  3. Code coverage card : https://github.com/gotwarlost/istanbul integration perhaps even https://github.com/es-analysis/plato style?
  4. Story card : https://github.com/kadirahq/react-storybook/blob/master/docs/writing_stories.md?
  5. Standalone card viewer (without navigation elements) devcard this.devcard.js

a-c-m avatar May 19 '16 09:05 a-c-m

jsdoc would be awesome as it is already broadly used for inline documentation

gabssnake avatar May 20 '16 08:05 gabssnake

The jsdoc idea really sounds interesting.

busypeoples avatar May 20 '16 12:05 busypeoples