Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  • Initiatives:

  • Devhub: https://developers.fioprotocol.io

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

...

Update Integration Documentation (In Progress)

The goal include:

  • Update devhub with more dev examples and information for the API, chain, and SDKs.

  • Focus on the integration process and create smaller, step-by-step examples

  • Link to or pull in development information from the knowledge base

  • Rearrange Devhub content to make some of it more “integration process centric”

  • General UX update to Devhub

  • For current list of other Devhub improvements refer to: https://github.com/fioprotocol/fio-devhub/issues

...

Item

Summary

Links

Status

Rework navigation and user flow

  • Currently, the site takes a “list information” approach and is not geared to a specific user (e.g., wallets, exchanges, etc.)

David Gold suggested we migrate to target specific integrators: Wallet Integration, Exchange Integration, etc. We would pull out common tasks into shared pages, but would gear the integration language to be specific to the different use cases.

Suggested outline: https://docs.google.com/document/d/1fu0KJr_pYg75WJN7zgtvx459vKUzPh2iFWfGhAsTpFM/edit?ts=60888ed6

Status
colourGreen
titleIn Progress

Building an API node and upgrade process (for wallets and exchanges)

  • Create a document on the different paths to building an API node

https://github.com/fioprotocol/fio-devhub/issues/95

https://github.com/fioprotocol/fio-devhub/issues/7

Status
colourGreen
titleIn Progress

Integration guide

  • Fixes to new integration guide from Pawel

https://fioprotocol.atlassian.net/browse/BD-2496

Status
colourGreen
titleIn Progress

Integration Checklist

  • Complete integration checklist page.

  • Include list of which integrations are done for which partners

https://github.com/fioprotocol/fio-devhub/issues/28

https://github.com/fioprotocol/fio-devhub/issues/8

Certification

  • Complete certification pages. Include map all currencies and review on http://bloks.io

https://github.com/fioprotocol/fio-devhub/issues/28

BP Voting and Proxying

  • Updating voting page to clean up and add intro on how to research BP activity

https://github.com/fioprotocol/fio-devhub/issues/112

https://github.com/fioprotocol/fio-devhub/issues/20

Support landing page

  • Create general support landing page

Pub/Priv Keys

  • Info on deriving and validating FIO Pub/Priv Keys

https://github.com/fioprotocol/fio-devhub/issues/11

EOSIO content

  • Use content similar to eosio

https://developers.eos.io/welcome/latest/introduction-to-eosio/index

https://developers.eos.io/manuals/eosjs/latest/how-to-guides/index

Devhub Readme

  • Create readme similar to eosio

https://github.com/eosdac/eosdacio-website/blob/master/docs/02-create-page.md

Ecommerce Integrators page

  • Home page link for ecommerce integrators - work with Pawel

FIO Dev Guide

  • Contributing to FIO dev page

Example: https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md
https://cryptowords.github.io/who-controls-bitcoin-core (not sure if that’s the post I was thinking of, but there are others that talk about this)

https://github.com/fioprotocol/fio-devhub/issues/92

Transactions

  • Transactions - document exact steps on devhub. Are there missing pieces for wallets and/or exchanges that we need to fix?

https://github.com/fioprotocol/fio-devhub/issues/50

Multicasting

  • Create document on accessing FIO nodes (multicasting)

https://github.com/fioprotocol/fio-devhub/issues/110

BP Fee setting

  • BP Fee setting - update with links to tools

https://github.com/fioprotocol/fio-devhub/issues/108

Address/Domain renewal

  • Add page on address/domain renewal

https://github.com/fioprotocol/fio-devhub/issues/103

API Error Codes

  • Clean up error codes (and make generic) some 403s look incorrect.

  • Add 202 response to all actions (make this generic). See old site

https://github.com/fioprotocol/fio-devhub/issues/91

History API

  • Add history API

https://github.com/fioprotocol/fio-devhub/issues/21

FIO Versioning

  • Port Versioning document from confluence

https://github.com/fioprotocol/fio-devhub/issues/22

OBT and Request auth checks

  • Writeup on authority checks with FIO Requests

https://github.com/fioprotocol/fio-devhub/issues/23

general BP info

  • Links to different BP resources

https://github.com/fioprotocol/fio-devhub/issues/27

Indexing transactions

  • Add more detail on indexing transactions

https://github.com/fioprotocol/fio-devhub/issues/50

FIO Contract development

  • FIO Contract development - Description of how to create actions and getters in contracts

https://github.com/fioprotocol/fio-devhub/issues/54

Mapping options

  • Document different mapping options

https://github.com/fioprotocol/fio-devhub/issues/1

Compatibility matrix

  • Matrix for different releases

https://github.com/fioprotocol/fio-devhub/issues/9

Known issues

  • Document the known issues and helpful hints with SDKs, APIs, and chain.

https://github.com/fioprotocol/fio-devhub/issues/10

FIO Chain Overview

  • Complete FIO Chain Overview

https://github.com/fioprotocol/fio-devhub/issues/12

FIO Glossary

  • Add a glossary of FIO terms

https://github.com/fioprotocol/fio-devhub/issues/13

Devnet setup

  • Add a section on devnet setup

https://github.com/fioprotocol/fio-devhub/issues/14

Simplify FIO Integration (In Progress)

It also must be easier to integrate FIO using the SDKs and interact with the FIO API directly. Simplification of FIO integration can be broken down into 3 areas:

...