Looking to help, thank, and seek efforts in updating graphene documentation for Steem, BitShares, PeerPlays, and Muse.
Looking to help improve documentation for graphene as some in the community have asked me to reach out with this if I may. Talked to a few people and noticed an update yesterday that I would like to take the time to share and also say thank you to @wackou. Good to see things getting updated and wonder what we may work together to get done to get more done and updated for businesses, developers, people, and projects interested in using graphene technology with some of the crypto we work closely with including BitShares & Steem and now including PeerPlays & Muse.
Have been asked specifically by OpenLedger's AppTrade if we could work on finding a solution to getting more of the bitshares documentation updated. As it would be very helpful to their business and many others to be built on bitshares.
Initially @tsugimoto responded to my post: Virtualgrowth with OpenLedger's Apptrade seeking help with updating bitshares documentation with her reply:
Hi @virtualgrowth, Please use me. You can check my old post Anyone interested to build a service on a blockchain?. I really would love to help. You can ask @officialfuzzy about me. He is my friend.
Upon reaching out to @Fuzzy came high recommendation. After speaking some with @tsugimoto and exchanging some feedback and ideas led to:
BitShares Technical Documentation - Table of Contents List (Updated with links) by @tsugimoto
This went from a graphic map idea of the documentation to a great layout of links for easier reference of the bitshares documentation.
@cm-steem also added some input
Updated API docs would be great, such as providing an example usage and output (so users don't need to perform trial & error to establish correct input data).
Additional websocket examples would be cool too.
Edit: Some in depth descriptions of MPA settings would be valuable, currently they're merely defined where as their min/max/suggested values aren't defined.
Would like to work on improving some of these things along with many others. Also included a link to some work that may provide information on how we may further improve the bitshares documentation as well.
Perhaps also providing UI customization docs would be a good idea? I previously created a simple guide which could be included in the wiki's and improved upon: Bitshares UI customization guide!
Bitshares UI Theming/Modification guide!
This is a draft guide for an older version of the Bitshares-UI, subsequent updates will increase the accuracy/quality of the guide. This guide is MIT licensed & open source on GitHub, I'd appreciate input on the guide & will happily merge pull requests.
Then searching around I found BTS Tools Documentation Release 0.4.14 (PDF)
Great thank you to @wackou for this that I found this update that appears to have been released yesterday! Check out the contents of the graphene tools documentation that is available for use with BitShares, Muse, PeerPlays, and Steem. Please vote for him for witness if you like and appreciate his work as he mentioned in the documentation:
The BTS Tools will help you build, run and monitor any graphene-based client (currently BitShares, Steem, Muse,
PeerPlays).
Note: these tools were originally developed for the BitShares network, and later expanded to support any graphene-
based network. This means that everywhere you will see BitShares mentioned in this documentation, it should be
understood as BitShares, Steem, PeerPlays or Muse. Similarly, bts can be interchanged with steem, ppy, and muse.
There are 2 tools currently provided:
• a command line utility allowing to quickly build and run any graphene-based client
• a web application allowing to monitor a running instance of the client and send an email or push notification on failure
If you like these tools, please vote for witness wackou on the Steem, BitShares and Muse networks. Thanks!
Working with various Graphene clients
The BTS Tools have originally been developed for managing BitShares witnesses (delegates at the time), but thanks
to Graphene providing a common substrate for blockchains they are now able to handle all the following blockchains:
• bts: BitShares
• steem: Steem
• ppy: PeerPlays
• muse: Muse
Support for the various Graphene clients is built-in directly in the bts cmdline tool, and you only need to specify the corresponding build environment, e.g.:
$ bts build steem # build the Steem client
$ bts run muse # run the Muse client
If you don’t specify a environment, it will use the bts environment by default. As a convenience feature, the following
aliases to the bts command-line tool are provided:
• steem: uses the Steem environment by default
• ppy: uses the PeerPlays environment by default
• muse: uses the Muse environment by default
Also reached out to @xeroc who has been a great help to the community who recently posted: docs.bitshares.org moves to bitshares organization on github
ChainSquad GmbH is pleased to announce that the BitShares/Graphene documentation sources have been successfully migrated to the bitshares organization on github.
By opening up the repository to the BitShares organization, we hope to bring in more powerful hands to keep it updated and extended.
Sources: Download
Delivery/Deployment
The documentation is built by readthedocs which also hosts the final end result.
Thank you to users in the community who have assisted with graphene documentation (updates). Please support the people who help with updating things like our graphene documentation by upvoting their content and voting for their witnesses.
Best,
@virtualgrowth
