chore: 🤖 consolidate development environment (technical debt) #783
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why?
The following PR consolidates the development workflow by removing the legacy index.html dev vite/server in favour of Storybook stories. It also cleans up redundant documentation and unused assets to reduce technical debt.
Originally, the project had two development environments that were concurrent: a static index.html page that loads a component that attempts to load all components, versus Storybook stories.
We get rid of the static index.html, controlled by the command dev, in favour of Storybook stories as the source-of-truth. It's easier to maintain the docs and tool that provides most value. Also, the original dev is not documented and it's a soup of components. It's much easier to communicate via a story, e.g. you want to showcase use-cases of any kind effectively.
Included improvements in the documentation, e.g. remove concurrent/conflicting instructions found in separate markdown documentation to favour README.md, reducing maintenance, or conflicting instructions. Other changes include the removal of unused or legacy files!?, e.g. Icons.mdx, stylesheets.
How?
Preview?
Before
After