Technical documentation strategy

There are several options regarding hosting of technical documentation, each of which has pros and cons across several dimensions. This document tracks the discussion regarding FIO’s strategy for hosting our technical documentation.

Decision

While we do not need to do all of the migration work right away, we do need a strategy for where documentation will live so we can start work on the more pressing updates to our documentation.

Technical documentation includes:

• Developer/Integration documentation (example guides, code recipes, information on SDKs, API Specification)

• FIO Chain (node and producer info)

• Knowledge base:

• Product and Development designs and specs

We currently host technical documentation in several locations:

• Web site: https://fioprotocol.io

• KB: https://kb.fioprotocol.io

• Dev Hub: https://developers.fioprotocol.io

• API: https://developers.fioprotocol.io/api/api-spec

• Wiki: https://fioprotocol.atlassian.net/wiki/spaces/FC/overview?mode=global

• GitHub: https://github.com/fioprotocol

Some of the requirements that need to be considered when selecting a documentation portal:

• UI

• Security

• Community access and co-development