The purpose of this repo is to unify all the documentation for the public-facing components of Mycroft.AI, and to reduce the fragmentation of documentation.
It is intended that the Markdown in this repo will be consumed by transformation layers or integrations to present the documentation in a user-friendly way.
@kathyreid - Kathy Reid (mailto:[email protected])
At the time of writing, the Docs Repository has only a single branch, master. This is the default branch for the repo.
The following conventions are observed in Mycroft documentation:
- All code is presented
like this - All Mycroft-specific terms are bolded
- Information is presented in 'inverted pyramid format'. This means an overview is given first, then more detailed information, then more granular information.
- Human-written documentation is done in Markdown, on GitHub
- Documentation of code is done through Google DocStrings format https://google.github.io/styleguide/pyguide.html#Comments and this then passed to documentation generators.
Mycroft documentation is written with the following tone of voice:
- Knowledgeable but never arrogant
- Helpful but encouraging of self-discovery
- Easily readable, but not dumbed down
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent