Content Organization
fde31 opened this issue · comments
Came up in a chat with @catarak
We could investigate a TOC, ad banners/intros to READMEs explaining the key usage/what to learn from the specific example.
Also a section for "bigger" projects/external resources seems worthwhile in order to not limit us to maintain everything within the same repo.
Turning this into some action items:
- Investigate ToC (Table of Contents) generation
- update current examples with more descriptive descriptions, add key usage and what you will learn from looking at a specific example
- Add step to adding an example guide that outlines how to write a good description for an example
- Differentiate between basic examples and intermediate/advanced examples
- Add option in guide to link to example in other GitHub repository rather than copying it to this repo
These sound groovy to me, thanks for chatting guys.
closing this has been tackled with the split of the repos