Open juanca opened 4 years ago
We should be able to have hooks as individual entries in the site. This helps expose our internal hooks to be shared and composed into additional components.
Grouping components in the filesystem and documentation site
How to deprecate a component
How to avoid adding "duplicates" components
More fleshed out descriptions per component. Maybe something from product or design. Examples:
What: Detect any JS console error / warning / etc that indicate something is wrong and fail our test suite.
Why: It looks like we can set up bad examples and our tests do not fail.
How: We should be able to inject JavaScript into the site that captures all errors and exposes some API to query for them. Cypress should then assert a lack of errors.
This seems to not be reproducible in our Jest environment because the error is thrown in the React DOM library which might not be used in a browser-less environment (as far as I can tell).
Now that we're understanding the various things that consists a design system, we should spell those out in the site.
example (not perfect):
And how to go about thinking about them in the product development cycle.
This would allow other contributors to verify whether there is a missing component and hopefully encourage them to go and build it.
Looks like we're generating a lot of internal requirements for improvements on the site. Some kinda seem outside the realm of Styleguidist. We should at least track these and possible solutions somewhere. Here seems good enough.