Author Topic: Documentation Efforts (Technical Documentation/Dedicated Webpage)  (Read 2514 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
I also just updates the doxygen page on https://bitshares.org/doxygen
It is now up to date again!


Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12922
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc

Offline rnglab

  • Full Member
  • ***
  • Posts: 171
    • View Profile
  • BitShares: rnglab
« Last Edit: October 06, 2015, 01:50:58 am by rnglab »

Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12922
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc


Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12922
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc

Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12922
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc
I decided to put a nicer layout there and hope for cass to find some time for cassification :)


Offline emailtooaj

Absolutly this a great and needed initiative %5
Sound Editor of Beyondbitcoin Hangouts. Listen to latest here - https://beyondbitcoin.org support the Hangouts! BTS Tri-Fold Brochure https://bitsharestalk.org/index.php/topic,15169.0.html
Tip BROWNIE.PTS to EMAILTOOAJ

Offline cass

  • Hero Member
  • *****
  • Posts: 4311
  • /(┬.┬)\
    • View Profile
Great initiative - go for it .. i will go over the design at weekend .. won't be able before :(
█║▌║║█  - - -  The quieter you become, the more you are able to hear  - - -  █║▌║║█

Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12922
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc
Hey there,

The last few days I tried to come up with a solution for documentation of Graphene/BitShares2.0 and found 'sphinx', a quite nice too for documentation which also takes doxygen xml files to add the comments from the source code easily. The docs are written in 'resStructured Text' which is close to Markdown.

Since I cannot do all the documentation on my own (at least not in a timely manner) I would like to ask for assistance.

The current work is deployed at:
http://docs.bitshares.eu

and the sources can be found at:
https://github.com/BitSharesEurope/graphene-docs

I also have started a skype group to discuss documentation in general.
Whoever feels fit to do little, medium or large-scale documentation is welcome to join and bring some high quality docs to life. I'll add you to the skype group if you desire.

I would like to encourage everyone to participate if possible to have a solid documentation within the User Interface at launch date.

The next two weeks is you chance to
a) support your favour blockchain project
b) get your name into the UI repository (via git)
c) earn some reputation

I have not yet asked BM to obvious, but I am confident that everyone participating in the documentation will earn some BROWNIE.PTS ..

//edit: talking about 'high-quality': I informed cass already about the quite ugly appearance of the docs and we will have a much nicer page hopefully soon.

Cheers
 -- Fabian
« Last Edit: October 02, 2015, 11:08:05 am by xeroc »