author	owner	lastupdate
Don Glover	Don Glover	202104.14

gaia-docs

We are using the Microsoft Writing Style Guide as our basic guide to creating content. As we find areas where we need to or want to deviate from the guide we will create our own addendum document.

Two primary branches

• Main - Docs are built out of here using DocFX
• Master - Primary repository for the docs. Can contain docs that aren't released yet. Update PRs here.

index.md in the main folder is the entry doc to the site. Each folder has an index.md file that is the entry point to that area. toc.yml contains the table of contents for that folder. For information about the structure of the ToC files, see Table-Of-Content (TOC) Files in the DocFx documentation.

Folders:

• api - API reference documentation
• articles - the main topics in the documentation
  • images - Proposed: subfolders containing the images for a specific topic in articles
  • templates - template topics
    • images - Proposed: subfolders containing the images for a specific topic in templates
  • tutorials - tutorial topics
    • images - Proposed: subfolders containing the images for a specific topic in templates
• images - DocFx wide images
• src - contains code to customize the DocFx output
• obj - DocFX internal

Topic metadata

---
author:
owner:
lastupdate:
---

author is the author of the topic. This is the person to contact to make updates to the topic.

owner is the current maintainer of the topic. This is the person on the hook to make sure that the content is current and accurate.

Note: Author and owner can be the same person.

lastupdate is the last major update to the content. Additions, major corrections, changes in functionality, etc. Do not update for typo corrections, grammar corrections, or minor corrections.

Writing hints

• Use no more than 30 words per sentence
  • Due to the fact that: Use because
  • Lacked the ability to: Use could not
  • In order to: use to
• Does it past the "so what" test?
  • If you delete the paragraph, would the reader miss it?
  • How does it enhance the reader's understanding?
  • What are the implications of your claim?