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
Dev Hub: https://developers.fioprotocol.io
Wiki: https://fioprotocol.atlassian.net/wiki/spaces/FC/overview?mode=global
GitHub: https://github.com/fioprotocol
Devhub Upgrade (to an Integration dashboard)
The FIO Website is moving to user-centric messaging. I is generally agreed that the more integrator-centric messaging that gets included on the fioprotocol.io the more confusing it will be for users. In addition, it has been proposed that we “merge” in the dApp with fioprotocol.io into a “user dashboard” to enhance usability and create a single FIO experience for users.
So, what do we do with all of the technical content and where do we send integrators and developers?
One direction we may want to consider is to rework the devhub content to make it more of an “integrator dashboard.” Currently, there is a mix of block producer, FIO developer, and integrator content. This change would refocus on integrators, but would still support, secondarily, other technical content. This new site would:
Be primarily focused on integrators.
Have a very clear path for getting integrators up and running as quickly and painlessly as possible.
Clearly outline the ease of use and monetary benefits of integration.
Eventually have an integrators "dashboard" where they can view stats on how much they have earned, see their TPID, see who is registered, etc.
Note: one thing we may want to have on the fioprotocol.io “user dashboard” is the actual status of the integrations. This content seems more beneficial for users rather than integrators.
Knowledgebase migration plan:
It was decided to migrate the Knowledgebase content from the KB to the Website (fioprotocol.io), the Devhub, and the Atlassian wiki. The following table outlines the KB content and the proposed migration path.
...
Knowledgebase content
...
Migrate to:
...
Assigned to:
...
Status
...
Welcome to FIO
...
N/A?
...
Terms and Glossary
...
Devhub
...
FIO Protocol Overview
...
Devhub
...
FIO Addresses
...
Devhub
...
FIO Domains
...
Devhub
...
Bundling and Fees
...
Devhub
...
Format
...
Devhub
...
Domain/Address Expiry
...
Devhub
...
FIO Requests
...
Devhub
...
FIO Data
...
Devhub
...
Enhanced Privacy
...
Devhub
...
Benefits and Bounties for Wallets
...
Devhub
...
Benefits and Incentives for Exchanges
...
Devhub
...
FIO Chain Overview
...
Devhub
...
Block Production
...
Devhub
...
Fee Setting and Distribution
...
Devhub
...
Token Overview
...
Devhub
...
Distribution Schedule
...
Devhub
...
How to vote FIO Tokens for BPs
...
Devhub
...
Foundation Overview
...
Ecosystem Participants
...
Roadmap
...
Devhub
...
Domains and Addresses
...
Foundation token use roadmap
...
User Guides (various)
...
fioprotocol.io user dashboard?
...
Community Links
...
Whitepaper
...
Moved to: Website, KB, devhub, and technical documentation strategy