This folder describes what makes entries "correct". All entries in the repository should follow these specifications. It was decided to forego having a formal YAML schema to have more fine-grained constraints that can not be expressed by structural schema alone.
Note that on top of the individual specs, the files still have to be properly-formatted yaml files. Mind the umpteen ways to write strings. It also means yaml features can be used within them. A very useful example is anchoring to reuse fields.
Some fields are specified as "must resolve to markdown". For these fields, CommonMark and Github-Flavored Markdown elements are supported.
A custom admonition syntax can also be used:
::: info
This is an info box.
:::
::: tip
This is a tip.
:::
::: warning
This is a warning.
:::
::: danger
This is a dangerous warning.
:::
::: details
This is a details block.
:::
When linking to another API documentation entry, use the entry's filepath starting from /api/ and removing the .yml.
For example, to link to the Card.AddCounter entry, use /api/functions/Card/AddCounter
(though unfortunately, github doesn't resolve links in yaml files so there will be no visual feedback).