Proposal: Hive Developer Documentation (2021)

inertia(74)

Published in

HiveDevs

Words

0

Reading

0 min

Listen

Play

2021-01-07 18:58

Synopsis

I will provide documentation intended for application and tool developers who work on the Hive blockchain.

Timeframe

Approximately 14 months from the start of the approved proposal (2021-01-12 through 2022-03-12). ~~I'm requesting 130 HBD per day, total for the timeframe: ~ 55,120 HBD~~ ~~Requested amount reduced to 45 HBD on 2021-04-01~~ Requested amount reduced to 0 HBD on 2021-07-20, making remaining timeframe ~ 0.00 HBD.

Deliverables

For the duration of the proposal work timeframe:

Regular pull requests directed at the devportal gitlab to appear on https://developers.hive.io once merged; including, but not limited to:
- "API Definitions" section updates
  - New methods, method changes, and operation details.
  - Continued search index integration into articles to aid reverse-lookup for related methods (e.g.: https://developers.hive.io/search/?q=get+version)
- "Recipes" section updates, which are programming-language-agnostic tutorials
- Maintenance of existing documentation to ensure ongoing relevance.
  - Integration of current blockchain posts, where applicable, using the Jekyll::Hive
    plug-in.
Post updates on details of ongoing deliverables in the timeframe.
Anything else that shows up as issues.

Qualifications

I have many projects that have relied on a deep understanding of the API. Prior to the existence of the original devportal, I wrote clients and applications by relying on information in articles all over the blockchain.

It'd be better if most people didn't ever have to do this kind of hunting. My goals are not only to collect the information in one place but also verify the accuracy.