Yaml documentation

[jdtsmith]

Thanks for working on this. I think it's OK to merge as is and improve later. There is a lot of info pertinent info missing from the Wiki text I wrote. Probably good to have a high level format with a pointer to the Wiki (which we can reorganize to make it more "permanent"). I'd also suggest therefore dropping the full example, as that's in the Wiki. I can also clean that up and check that in so we get versioning on it; it's in org not rst, but most people will read online anyway and won't know the difference I guess.

[codecov-commenter]

Codecov Report

Merging #213 (c4d59ea) into master (2c6afb6) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #213   +/-   ##
=======================================
  Coverage   43.84%   43.84%           
=======================================
  Files          12       12           
  Lines         821      821           
=======================================
  Hits          360      360           
  Misses        461      461           

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 2c6afb6...c4d59ea. Read the comment docs.

[Dhruvil2911]

Yeah I've reset the PR just to the changes in the documentation.

[jdtsmith]

@drvdputt can you take a look at this and see if it may be useful for your documentation efforts? To me this looks mergeable but I know you may be working on these same files.

[drvdputt]

I have a placeholder "YAML format description here" in my documentation (on the same page). So yes, some parts of this will be useful, even if a bit outdated. There will be a merge conflict, but since it's only documentation, a bad merge won't break anything. I can just reorganize the different parts.

[jdtsmith]

Great thanks both.