Re: Attacking the documentation monster

2022-08-02 Thread Martin Schanzenbach
Hi all, the new documentation is not live at https://docs.gnunet.org. Please report any issues here or in the bugtracker. Thanks Willow for your work in particular. I think this gives a much better impression of the project. As a sideeffect, GNUnet now no longer depends on texinfo in order to bui

Re: Attacking the documentation monster

2022-07-31 Thread Martin Schanzenbach
Hi all, I created a new separate repo here for the new handbook format: https://git.gnunet.org/gnunet-handbook.git As you can see, I have decided to use markdown instead of rst. We can include it as as submodule for gnunet.git when the time comes. I have already "translated" some of the chapters

Re: Attacking the documentation monster

2022-07-27 Thread Schanzenbach, Martin
Hi, > On 27. Jul 2022, at 19:35, Willow Liquorice wrote: > > Hello, > > Yeah, I've done quite a bit of work on that front. I believe I used the > pandoc method in the end to translate it all to (rough) reST. The conversion > isn't perfect: the heading hierarchy is a bit iffy and it completely

Re: Attacking the documentation monster

2022-07-27 Thread Willow Liquorice
Hello, Yeah, I've done quite a bit of work on that front. I believe I used the pandoc method in the end to translate it all to (rough) reST. The conversion isn't perfect: the heading hierarchy is a bit iffy and it completely breaks the index (a blessing and a curse, Sphinx's indexing is a lot

Re: Attacking the documentation monster

2022-07-27 Thread Schanzenbach, Martin
Hi, I was wondering if you had started with sphinx/rtd for the handbook already? If not, I have played around with it today and already have migrated some text and could commit it to gnunet.git or a new repo. That would allow anyone to play around and add content. But if you are already further,

Re: Attacking the documentation monster

2022-05-24 Thread Willow Liquorice
Ah, you can do it through pandoc. I'll bear that in mind and see about adapting it to our repository. On 24/05/2022 22:16, Nikita Ronja Gillmann wrote: Hi, qemu did this a while back it seems On 5/24/22 22:38, Willow Liquorice wrote: As an aside, *does anyone know of any tools to convert TeXi

Re: Attacking the documentation monster

2022-05-24 Thread Nikita Ronja Gillmann
Hi, qemu did this a while back it seems On 5/24/22 22:38, Willow Liquorice wrote: As an aside, *does anyone know of any tools to convert TeXinfo to reST*? This migration is going to be much smoother if there are. https://patchwork.kernel.org/project/qemu-devel/patch/20200226113034.6741-19-pbon

Re: Attacking the documentation monster

2022-05-24 Thread Willow Liquorice
Ah, good. The doxygen site's showing the correct version number now. Another point in favour of integrating source docs into the handbook: I think the docs for libgnunetutil and other documentation for libraries could really benefit from it, as they are rather skeletal and the doxygen site isn

Re: Attacking the documentation monster

2022-05-24 Thread Christian Grothoff
The doxygen configuration file in Git just had an ancient version number. I've fixed that now. The rest was up-to-date ;-). -Christian On 5/23/22 16:24, Willow Liquorice wrote: Just look at https://docs.gnunet.org/doxygen/html/index.html and you'll see what I mean. - Willow On 23/05/2022 15:

Re: Attacking the documentation monster

2022-05-23 Thread Willow Liquorice
Just look at https://docs.gnunet.org/doxygen/html/index.html and you'll see what I mean. - Willow On 23/05/2022 15:23, Christian Grothoff wrote: I cannot even find a version number on https://docs.gnunet.org/, so that's likely not what you are refering to. So where exactly are you looking to f

Re: Attacking the documentation monster

2022-05-23 Thread Christian Grothoff
I cannot even find a version number on https://docs.gnunet.org/, so that's likely not what you are refering to. So where exactly are you looking to find documentation for 0.11.x? Likely some code to update some location is not working (or was never written, and someone put something out manuall

Re: Attacking the documentation monster

2022-05-23 Thread Willow Liquorice
Alright, doc/sphinx it is. The handbook is already intended for two wildly different audiences, what with being both a user's and developer's manual. Having the source code documentation in one place (and possibly better organised) might make it easier to work with, and help keep the Developer

Re: Attacking the documentation monster

2022-05-23 Thread Christian Grothoff
On 5/23/22 00:57, Willow Liquorice wrote: Hello again, Thanks for the info, good to hear that I've got most of it. Setting up a branch in my local GNUnet repository, to start experimenting with Sphinx, as I write this. Seeing as there's some experience with the software in the project already

Re: Attacking the documentation monster

2022-05-22 Thread Willow Liquorice
Hello again, Thanks for the info, good to hear that I've got most of it. Setting up a branch in my local GNUnet repository, to start experimenting with Sphinx, as I write this. Seeing as there's some experience with the software in the project already, where would be the most sensible place t

Re: Attacking the documentation monster

2022-05-22 Thread Christian Grothoff
Hi Willow, We've been using RST/Sphinx for the GNU Taler documentation, and it can generate reasonable TeXinfo. From that experience, I'm not against converting the existing documentation to RST. As far as finding the documentation, I think you found most of it, except maybe the RFC-style sp

Re: Attacking the documentation monster

2022-05-19 Thread Willow Liquorice
I've got some free time on my hands now, and I gave some thought to improving the readability of the HTML documentation on the website (which is what the average prospective GNUnet dev is going to look at). Read the Docs and friends set the standard in this regard. Having the contents in a side

Re: Attacking the documentation monster

2022-03-01 Thread Maxime Devos
William Liquorice schreef op di 01-03-2022 om 19:51 [+]: > Hello, > > A year or two ago, I tried to wrap my head around GNUnet so that I could > try to make parallel implementations of small bits in Rust, but found > its documentation to be utterly impenetrable. Not even from a technical >

Re: Attacking the documentation monster

2022-03-01 Thread Christian Grothoff
Spam killed this. We already constantly have to delete 'bug reports' from the Web that were submitted as link spam. A wiki will drain resources to keep the spammers out, and at the same time experience says the contributions will be low quality (it has been tried). If someone really is capable and

Re: Attacking the documentation monster

2022-03-01 Thread madmurphy
I don't know if this will be a popular proposal, but I really believe that setting up a self-hosted Wiki could be a very good choice. No complicate git clone, no complaints, just read/edit what you need, and distributed responsibilities about its design and direction. My two cents On Tue, Mar 1,

Re: Attacking the documentation monster

2022-03-01 Thread Christian Grothoff
On 3/1/22 8:51 PM, William Liquorice wrote: > Hello, > > A year or two ago, I tried to wrap my head around GNUnet so that I could > try to make parallel implementations of small bits in Rust, but found > its documentation to be utterly impenetrable. Not even from a technical > standpoint, the mass

Attacking the documentation monster

2022-03-01 Thread William Liquorice
Hello, A year or two ago, I tried to wrap my head around GNUnet so that I could try to make parallel implementations of small bits in Rust, but found its documentation to be utterly impenetrable. Not even from a technical standpoint, the massive reference manual / "handbook" is quite overwhel