BitShares Forum

Main => Technical Support => Topic started by: xeroc on October 01, 2015, 09:41:00 am

Title: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: xeroc on October 01, 2015, 09:41:00 am

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

Title: Re: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: cass on October 01, 2015, 11:23:19 am

Great initiative - go for it .. i will go over the design at weekend .. won't be able before :(

Title: Re: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: emailtooaj on October 01, 2015, 12:32:16 pm

Absolutly this a great and needed initiative %5

Title: Re: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: rnglab on October 02, 2015, 07:01:42 am

 +5%!

same as for user interface documentation:   
  https://bitsharestalk.org/index.php/topic,18697.msg240570.html#msg240570 (https://bitsharestalk.org/index.php/topic,18697.msg240570.html#msg240570)

Title: Re: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: xeroc on October 02, 2015, 09:11:16 am

I decided to put a nicer layout there and hope for cass to find some time for cassification :)

Title: Re: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: xeroc on October 02, 2015, 11:08:13 am

Now available at http://docs.bitshares.eu

Title: Re: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: rnglab on October 03, 2015, 07:57:05 am

great!

This should work as on bitshares.org: http://docs.transifex.com/integrations/sphinx-doc/#live (http://docs.transifex.com/integrations/sphinx-doc/#live)

Title: Re: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: xeroc on October 03, 2015, 08:17:13 am

Quote from: rnglab on October 03, 2015, 07:57:05 am

great!

This should work as on bitshares.org: http://docs.transifex.com/integrations/sphinx-doc/#live (http://docs.transifex.com/integrations/sphinx-doc/#live)

very cool ..
I'll put it on my todo list

Title: Re: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: rnglab on October 06, 2015, 01:39:00 am

Quote from: xeroc on October 03, 2015, 08:17:13 am

Quote from: rnglab on October 03, 2015, 07:57:05 am

great!

This should work as on bitshares.org: http://docs.transifex.com/integrations/sphinx-doc/#live (http://docs.transifex.com/integrations/sphinx-doc/#live)

very cool ..
I'll put it on my todo list

http://docs.bitshares.eu (http://docs.bitshares.eu) is ready to publish translations made on https://www.transifex.com/bitshares/graphene-docs/
 (https://www.transifex.com/bitshares/graphene-docs/)

Thank you xeroc

Little howto here: https://bitsharestalk.org/index.php/topic,18711.msg240899.html#msg240899 (https://bitsharestalk.org/index.php/topic,18711.msg240899.html#msg240899)

Title: Re: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: xeroc on October 06, 2015, 06:24:01 am

Quote from: rnglab on October 06, 2015, 01:39:00 am

Quote from: xeroc on October 03, 2015, 08:17:13 am

Quote from: rnglab on October 03, 2015, 07:57:05 am

great!

This should work as on bitshares.org: http://docs.transifex.com/integrations/sphinx-doc/#live (http://docs.transifex.com/integrations/sphinx-doc/#live)

very cool ..
I'll put it on my todo list

http://docs.bitshares.eu (http://docs.bitshares.eu) is ready to publish translations made on https://www.transifex.com/bitshares/graphene-docs/
 (https://www.transifex.com/bitshares/graphene-docs/)

Thank you xeroc

Little howto here: https://bitsharestalk.org/index.php/topic,18711.msg240899.html#msg240899 (https://bitsharestalk.org/index.php/topic,18711.msg240899.html#msg240899)

and I wondered why the extra javascript code didn't do anything yesterday .. I understand it now :)
Good job!!

Title: Re: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: xeroc on November 13, 2015, 12:29:47 pm

https://bitsharestalk.org/index.php/topic,19967.msg256396/topicseen.html#msg256396

Title: Re: Documentation Efforts (Technical Documentation/Dedicated Webpage)
Post by: xeroc on November 13, 2015, 01:19:11 pm

I also just updates the doxygen page on https://bitshares.org/doxygen
It is now up to date again!