Proposal: Hive Developer Documentation (2021)

[inertia]

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.

Previous Work

See: my first proposal #10, followed by #39.

Proposal Record

Approve / Unapprove

---

Also see:

• https://peakd.com/proposals/inertia

Comments

[r0nd0n]

This is literally the most important thing right now. Hive can build more features, but how do you use them without documentation? Hive can market, but who will sink the costs of reading code to build a business? Right now, if you want to build, you have to find a kind soul that will hold your hand, or read through thousands of lines of code and understand the mechanics.

Maybe I'm being a bit hyperbolic, but if things as fundamental as documentation don't get funded, this place is doomed.

[marki99]

Voted

[howo]

neat, approved

[oblivioncubed]

Will this only be kept up-to-date until the end of the proposal? Will future updates require funding of new proposals, or will there be an effort to keep this data from being stale in 2 years without additional funding? (AKA: How long can we rely on this documentation being valid, up-to-date, and available?)

Note that I think it's a great initiative regardless of your answers to these questions, and have already supported it. Thank you! Hope to see this funded.

[inertia]

The devportal repo will continue to stay opensource and available for updates after this proposal timeframe. Historically, I have made changes since my last proposal, and so have others. Outside of funding, it's basically a hobby, which I do enjoy. But it hasn't been a priority.

So if it's funded, I can elevate priority beyond a hobby. It's hard to say what will be needed after two years, but I suspect there will be ongoing need. I guess we'll see what kind of priority will be needed.

[oblivioncubed]

Thanks! That makes sense and I think is a very exciting proposal.

[enforcer48]

Will get to this when I get home. If not, someone please remind me.

[poshbot]

[hivebuzz]

Congratulations @inertia! You have completed the following achievement on the Hive blockchain and have been rewarded with new badge(s) :

You received more than 52000 as payout for your posts. Your next target is to reach a total payout of 54000

_{You can view your badges on your board and compare yourself to others in the Ranking
If you no longer want to receive notifications, reply to this comment with the word STOP}

[marki99]

Finally the proposal is in. Very close to the return proposal though, kinda scary

[aagabriel]

Found this 5 year old Steemit post addressing the same problem we have here today.

Steem really needs a wiki: @samupaha in #steemit-ideas • 5 years ago

[inertia]

There is a hive wiki, by the way:

https://www.hive.wiki/

[aagabriel]

Indeed there is. How does one volunteer for it?

[aagabriel]

[erialos]

Hello Inertia. This would definitely be most valuable. I recently started up a full API node and I had many unanswered questions that just don't exist on the developer website page. Sifting through the how-to's written over a year ago to gain an idea of what's going on was helpful but a well-documented resource would be the best!

Was this funded already and is currently being worked on since it was approved? I'm not sure how this process fully works.