Documentation

Suggestions and discussion of future versions
shirish
Seeder
Seeder
Posts: 163
Joined: Fri May 25, 2007 4:01 am
OS or Distro: Debian Testing
Location: South Asia, India

Documentation

Postby shirish » Wed May 30, 2007 3:13 pm

Hi all,
There is no documentation to speak of. If I do a man deluge it shows very short page. There is virtually no documentation to speak of. Either in man or in /usr/share/doc/deluge-torrent. There is also no documentation at About tab in deluge-torrent.
The documentation can be either on-site or in the About Tab or somewhere. Something similar to faq perhaps http://www.utorrent.com/faq.php

Also i'm sure many people do not know that there are 2 libtorrent projects. The one which we are using is http://code.rasterbar.com/libtorrent while there is another project having the same name for the library. http://libtorrent.rakshasa.no This differentiation should be mentioned somewhere explicitly.
Debian Sid, Intel Dual-Core, 512 kbps DL , 64 Kbps UL, deluge-1.3.5, pieces plugin, GNOME 3.4.x

All posts under creative commons http://creativecommons.org/licenses/by-nc/3.0/

User avatar
zachtib
Leecher
Leecher
Posts: 97
Joined: Thu May 24, 2007 3:26 pm
OS or Distro: OS X 10.6
Location: Louisville, KY
Contact:

Re: Documentation

Postby zachtib » Wed May 30, 2007 3:16 pm

yeah, the problem is that we just haven't written it.

i hardly have time to code, let alone document it

but, if some of you are willing to work on it, I wouldn't mind starting a documentation team to handle this, and i'll set up a subforum for it...
Former Deluge Developer

shirish
Seeder
Seeder
Posts: 163
Joined: Fri May 25, 2007 4:01 am
OS or Distro: Debian Testing
Location: South Asia, India

Re: Documentation

Postby shirish » Wed May 30, 2007 3:49 pm

maybe its too premature to talk about it as I constantly run into few problems which I'm not sure are either the clients or the libtorrent or what? What we could start of with could be an FAQ which could also be a basis of the documentatin later on, perhaps? For e.g. questions like

1. What is deluge-torrent made of? (just the client created & the library or something's else also? )
2. Is deluge-torrent gnome specific or not? (GTK+)
3. Ports of deluge-torrent?
4. What is this libtorrent & where can I find more info. on it? ( Give the link to the site, wiki & development page)
5. What is DHT? When is it ok to have DHT on or off
6. What are private trackers and/or public trackers?
7. What is hash-checking?
8. What are peers?
9. What is port-forwarding? Is it necessary?

These are just the tip of the questions. While some of these questions I can answer some of them I don't know how deluge reads them or acts on them. Some of them might be also be depended upon either deluge (some version) or the library itself (libtorrent some version) so those need to be put up there & when those features are there then put the additional info.

What do u think? I also do like the idea of having a sub-forum. Btw did you get any info. on moving to trac 0.10.5dev or are waiting for 0.11 to hit the market Did you get any info. from the hosting co. as to what do they think?
Debian Sid, Intel Dual-Core, 512 kbps DL , 64 Kbps UL, deluge-1.3.5, pieces plugin, GNOME 3.4.x

All posts under creative commons http://creativecommons.org/licenses/by-nc/3.0/


Return to “Development”

Who is online

Users browsing this forum: No registered users and 10 guests