Author Topic: [Worker] Revision of Whitepapers and Improvements of Technical Documentation  (Read 7572 times)

0 Members and 1 Guest are viewing this topic.

Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12922
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc
Thanks for asking and looking into workers on a regular basis.
First of all, this worker has already delivered stuff. a) the new whitepaper, and b) the how.bitshares.works and dev.bitshares.works portals.
There is quite some work left on this front.

However, this worker is somewhat delicate as it was created when BTS was quite more valuable. As a consequence, the worker itself is not "fully funded" and the amount of hours we would have liked to spend just cannot be put there.

Offline Digital Lucifer

  • Sr. Member
  • ****
  • Posts: 368
  • BitShares Maximalist & Venture Architect
    • View Profile
    • BitShares
  • BitShares: dls.cipher
  • GitHub: dls-cipher
Will this work alongside current documentation uplift efforts? https://t.me/joinchat/AWRo40N1sGr9SNGo_pv3KA
The idea is to utilize the available resources there and merely guide the documentation efforts
to fit into the lessons learned (most compliance) ... We'd also like to find a solution to have a
community member deal with the project management and have everyone benefit from their
work. Consider the whole worker proposal a "bounty program" that is lead by Blockchain Projects BV
(as a legal entity to take the lead and responsibility) and put forth by the community under guidance.

Is there any updates on this Worker? As I understood it, the goal of this worker is to update the current online documentation.

So far, there hasn't been any updates to this since March in this thread, and the accounting page on bitshares.foundation, https://workers.bitshares.foundation/201802-documentation, mentions no invoice.

Does this worker post updates elsewhere, does it have a goal/roadmap on what is required to be done before the end and does it allow easy access for community submissions to its goal?

I believe that it was up to the Community and rest of the eco-system to step-up and claim Bounty on making the proper documentation. Far as initial expectations from this worker I see new WhitePaper done and a lot of Compliance in it.

https://dev.bitshares.works
https://how.bitshares.works
https://www.bitshares.foundation/papers/BitSharesBlockchain.pdf

CheeĀ®s
« Last Edit: October 01, 2018, 06:49:36 am by Digital Lucifer »
Milos (DL) Preocanin
Owner and manager of bitshares.org
Move Institute, Non-profit organization
RN: 2098555000
Murska Sobota, Slovenia.

Offline startail

Is there any updates on this Worker? As I understood it, the goal of this worker is to update the current online documentation.

So far, there hasn't been any updates to this since March in this thread, and the accounting page on bitshares.foundation, https://workers.bitshares.foundation/201802-documentation, mentions no invoice.

Does this worker post updates elsewhere, does it have a goal/roadmap on what is required to be done before the end and does it allow easy access for community submissions to its goal?

Offline pnomolos

It'd be great helping on either the frontend or library documentation.  I'd be willing to help on the backend documentation as well, but c++ is definitely not my area of expertise - if my help is most urgently needed there then I'd probably be much more useful writing higher level guides and tutorials as opposed to anything significantly technical.

I've joined the Telegram group so if it'd be easier to communicate directly there or via direct message that works too :)

Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12922
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc
While I'm more than willing to help with writing technical/UI documentation, I'd also love to get involved with some tooling to help automate what can be automated so more time can be focused on improving that which can not be automated.
This sound great! All the help is very much appreciated.
Do you prefer backend (c++) development, prefer frontend (js/react) stuff or would rather want to help on the library (python, js, java) side of things?
There is work left on all of those fronts :D

Offline clockwork

  • Committee member
  • Sr. Member
  • *
  • Posts: 376
    • View Profile
  • BitShares: clockwork
While I'm more than willing to help with writing technical/UI documentation, I'd also love to get involved with some tooling to help automate what can be automated so more time can be focused on improving that which can not be automated.

Sounds like exactly one of the people Fox is looking to hire for the core team. Check the new core team proposal and get in touch with Ryan if you haven't already.

Offline pnomolos

Voted.

From the UI documentation side of things, it's difficult to keep them up-to-date due to the fact that the client is still under very active development and things are changing regularly.  An idea that popped into my head would be the ability to be able to "tag" elements within the client with UI hints that could be then used by a selenium-driven tool for automatically generating new screenshots with the appropriate outlines/highlights.  Obviously this would not be able to cover all the cases, but perhaps it may be worth the time -- or someone has already written enough of a tool that we'd be able to piggyback off of?

As is the case with most open source projects, documentation tends to be the most neglected.  While I'm more than willing to help with writing technical/UI documentation, I'd also love to get involved with some tooling to help automate what can be automated so more time can be focused on improving that which can not be automated.

Offline Brekyrself

  • Hero Member
  • *****
  • Posts: 512
    • View Profile
This got voted in as well, BitShares is on a roll for getting things done!  I've never seen this many active workers!

Offline abit

  • Committee member
  • Hero Member
  • *
  • Posts: 4664
    • View Profile
    • Abit's Hive Blog
  • BitShares: abit
  • GitHub: abitmore
Firstly please get this site updated: https://bitshares.org/doxygen/classgraphene_1_1app_1_1database__api.html

Best automatically update it every time when there is a new release.

Last update was: Generated on Wed Jan 13 2016 11:43:49 for Graphene by   doxygen 1.8.10

Update: done. Generated on Sun Feb 4 2018 17:03:24 for Graphene by   doxygen 1.8.11

https://bitshares.org/doxygen/hierarchy.html

This is a good doc for reference.
« Last Edit: February 04, 2018, 05:20:32 pm by abit »
BitShares committee member: abit
BitShares witness: in.abit


Offline Chris4210

  • Sr. Member
  • ****
  • Posts: 431
  • Keep Building!
    • View Profile
    • www.payger.com
  • BitShares: chris4210
voted. I am looking forward to the updated and improved documentation. Please separate marketing and technical speech in the new documentation. They do not belong together. I was sitting with my team for weeks to pull these two things apart in the current documentation.
Vote Chris4210 for Committee Member http://bit.ly/1WKC03B! | www.Payger.com - Payments + Messenger | www.BitShareshub.io - Community based fanpage for the BitShares Blockchain

Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12922
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc
Will this work alongside current documentation uplift efforts? https://t.me/joinchat/AWRo40N1sGr9SNGo_pv3KA
The idea is to utilize the available resources there and merely guide the documentation efforts
to fit into the lessons learned (most compliance) ... We'd also like to find a solution to have a
community member deal with the project management and have everyone benefit from their
work. Consider the whole worker proposal a "bounty program" that is lead by Blockchain Projects BV
(as a legal entity to take the lead and responsibility) and put forth by the community under guidance.

Offline R

  • Hero Member
  • *****
  • Posts: 1004
    • View Profile
Will this work alongside current documentation uplift efforts? https://t.me/joinchat/AWRo40N1sGr9SNGo_pv3KA

Or could there be overlap in work being done?

Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12922
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc
The proposal says that total amount is $80,000 but later in the text it mentions that it's capped at $150,000.
Where are you going to find a content writer with extensive knowledge of BitShares? Are you relying on community?
Thanks for the report, the $150k was an error that was fixed.

There are actually knowledgable writers already working on a renewed documentation page, all it needs is funding to have this go forward ..

Offline paliboy

The proposal says that total amount is $80,000 but later in the text it mentions that it's capped at $150,000.
Where are you going to find a content writer with extensive knowledge of BitShares? Are you relying on community?