Website, KB, devhub, and technical documentation strategy

Owned by Eric Butz
Last updated: May 06, 2021
2 min read

This document has been archived because the contents of this page have been overtaken by other initiatives including:

Summary

There are several options regarding hosting of user content and technical documentation. This document tracks the discussion regarding FIO’s strategy for hosting our technical documentation and other user and integrator content.

Content includes:

  • User marketing and information

  • 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:

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.

Update: This has been moved into development and is tracked in the Improve FIO Integration Project Plan: Improve Integration Experience - Project plan

Knowledgebase migration

https://kb.fioprotocol.io

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.

  • Update 5/6/21: This has evolved and the current thinking is that we will continue to keep some technical information on the Knowledgebase