For headers it is recommended to use standard sentence structure, i.e. do not capitalize letters apart from the first word, specific terms or acronyms.
For example, use
## This header is correct for Movement Labs' MIPsDo not use
## This Header is Incorrect for Movement Labs' MIPsEnsure clarity and consistency in distinguishing between internal components and general roles. When referring to specific entities within our system, capitalize their names. Use lowercase when referring to general roles or concepts. For example:
- Relayer refers to our specific relayer, while relayer refers to any agent performing relaying.
- Validator refers to our designated validators, while validator is a general term for any entity validating transactions.
Avoid using
> [!NOTE]
> ...or
!!! note ...or
::: note ... :::These do not render correctly either in the GitHub preview or in the rendered markdown. Instead use emojis to indicate the type of note, e.g.
\> 馃憖 Note, that ...
\> :warning: This is a warning ..
\> :bulb: Here is something to learn ..