Skip to content

Various feedback for README.md #3

@elisechant

Description

@elisechant
  1. It would be helpful to clarify what is the point of this repo? Is it for documenting high level concepts or for building a design system in code?

  2. I like the concept (state) => ({ styles, view }), as it makes views also composable, meaning we can could technically build a functional design system without any UI and call that 1.0.0. This might be a good way to start the system, but also useful for flexibility of a styled system in the future.

  3. General readability suggestions:

  • Include Thinkmill's logo and branding at the top of the README
  • Terminology items should be hash links to their navigable heading
  • Where you reference other content such as "State management", why don't you simplify this repo by linking out to that instead of duplicating information to here? State management is not strictly a design system concern. Leave this documentation for design system concerns.
  1. I can see this is early days, but you seem to be missing whole sections like Testing, Types, Type Concepts, Component Inheritance, How to add a component.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions