c8r / kit

Tools for developing, documenting, and testing React component libraries

Home Page:https://compositor.io/kit

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MVP Proposal

jxnblk opened this issue · comments

Opening this issue to list out and discuss the minimal set of features to make this thing public. What I'm listing below are the things I think could be documented and ready to be consumed. There could be other WIP components and features that we leave in the repo, but don't worry about getting all the documentation right to start with.

  • Basic CLI
    • Dev server for components, MDX, and JSX files
    • Basic scaffolding generator (depends on how much more work is needed there)
  • Components
    • Library/Example (with updated API)
    • XRay
    • Responsive
    • LiveEditor
    • Debug
    • Color palette

@johno Also, curious to hear what you're thinking about with regards to the package naming convention. I was thinking there could be @compositor/kit which would include all sub-packages, then sub packages might be name-spaced like @compositor/kit-cli @compositor/kit-components, etc.

Think we should def also add in the scaffolding generator for MVP, I should be able to get the finished today.

I was thinking there could be @compositor/kit which would include all sub-packages, then sub packages might be name-spaced like @compositor/kit-cli @compositor/kit-components, etc.

Exactly what I was thinking as well 👍

I've also edited your comment to add in a ColorPalette component. Think that's a valuable one to have in MVP.

Yeah, I was sorta thinking that the style guide/theme related stuff could be a quick follow, minor update, but some of those components are probably in a good spot already

Closing this out since I think we've covered most of what's in here. More specific issues could be opened for things like the scaffolding generator templates