This repository contains all documentation files and pointers that serve https://skale.network/docs. It contains a combination of Markdown (md/mdx), AsciiDocs (adoc), and navigation schema (json).
To make changes, 1. First open an Issue to discuss your proposed changes. 2. Open a PR containing the suggested changes.
Please try to conform Markdown files to markdownlint.
For docs generated from Solidity inline Natspec, OpenZepplin's solidity-docgen is used. Suggested formatting is:
/* @dev [Description of function]
* [Line two of description]
*
* Emits a {EVENT_NAME} event.
*
* Requirements:
* - First requirement description.
* - Second requirement description.
*/
function ...Suggest to use a style linter such as Vale. Currently, the docs follow the Microsoft Writing Style Guide.