I wouldn't want the readme to get much bigger than it already is and the approach of adding component documentation there doesn't feel sustainable. Should we take another approach?
- Publish docs via GitHub pages and link from the readme?
- Something else?
Putting component documentation in the readme also feels duplicative and will increase maintenance burden when updating components because documentation will also need to be updated in multiple places. Where should component documentation live?
- Better utilise the documentation capabilities of Storybook?
- Use the SvelteKit app as a place to document and demonstrate use of components?
I wouldn't want the readme to get much bigger than it already is and the approach of adding component documentation there doesn't feel sustainable. Should we take another approach?
Putting component documentation in the readme also feels duplicative and will increase maintenance burden when updating components because documentation will also need to be updated in multiple places. Where should component documentation live?