Closed
Description
Docs could use a set of recipes with guidelines on authoring: creating kata, translations, writing tests, etc.
My current idea is to create structure of docs with following sections:
- set of articles for specific snippets, so they could be referenced by other parts. Keep them language-agnostic and present ideas and best practices behind them.
- general coding guidelines (Authoring guidelines: general coding guidelines #145)
- full tests (Authoring guidelines: submission tests #19)
- description (Authoring guidelines: descriptions #143)
- sample tests (Authoring guidelines: sample tests #146)
- proposed solution (Authoring guidelines: reference solution #147)
- preloaded (Authoring guidelines: preloaded code #148)
- find good place for language specific follow ups on above snippets (like Rewrite Python Test Framework docs #17). Probably location would be similar to how Add info on Snowhouse stringizers for C++ #115 was realized?
- creating kata (Authoring guidelines: creating kata #149)
- creating translation (Authoring guidelines: translations #134)
- creating kumite? (Authoring guidelines: creating kumite #150)
- create separate issue for every page to collect ideas, feedback and for better tracking. Link them here, maybe as a checklist? A couple of issues is already there.
- prepare structure in repo, create stubs, think on frontmatter stuff (tags, navigation, etc)
- when working on some article, update links and references to TODOs docs which will become outdated or moved (remember about sidebar!)
What do you think?