Consider splitting README into multiple docs
NyakudyaA opened this issue · 2 comments
NyakudyaA commented
Feature description
The readme has become quite long and will continue to grow, let's consider splitting it and keep the main features here and flesh out most of the doc using either
- GitHub wiki,
- Github pages
- Mkdocs.
We could have the following structure
- README.md
- docs/guide.md (Basics & Advanced Features)
- docs/best-practices.md
Additional context
No response
lewismc commented
👍