Skip to content
This repository was archived by the owner on Nov 26, 2024. It is now read-only.

Authoring documentation

Den Delimarsky edited this page May 24, 2016 · 10 revisions

This topic will contain information you need to know when authoring content in our system.

  1. Make sure all your files and arts are inside your docset. The current system will not be able to reference to any file that is not inside the docset (e.g. other repositories). Trying to reference a file outside the docset will cause the build to fail.
  2. When adding HTML comments, use the following syntax: <!-- Comments -->.
  3. If a topic has not been added to a TOC, then a TOC will not be shown when the topic is rendered.
  4. While we do not provide any templates out-of-the-box right now, please make sure that you abide to the common structure of existing Markdown files. Remember - this is documentation, not a blog. Contributions of a blog-like nature will be rejected.
Clone this wiki locally