Update documentation
deavmi opened this issue · comments
I noticed some broken English in the PDF documentation and I really love this piece of software, could I submit a PR?
Dear deavmi, sure, any help is welcome.
I will finalize my changes at the end of this week (SAST).
Great, many thanks!
It's an absolute pleasure. I really love seeing good projects out there and written in C too (more beautiful). Also I was looking for an easy to set-up NNTP server (INN was too confusing).
Also the fact you use TeX for the documentation makes it even better (knowing you're an academic makes it obvious that you'd use it - which is great! 👍).
I have tested it on my home network and it works great!
Considering I have a test upcoming soon I will make a PR now with my most recent changes and then afterwards see if I can do anything more to improve it and make further PRs.
Many thanks -- I'm glad to hear it. However, there are also open problems, e.g. missing NNTP features, missing support for TLS etc. Being easy to set-up was, however, a goal for that server. I also found INNd quite confusing (it probably just grew too complex).
PR is here now #6
Yeah I think it just grew too complex to be honest, in general I found it hard to setup as in I never got anything to work - it is a bit archaic in that sense.
TLS support would of course be nice but for now it is fine (I never send sensitive data over NNTP, I use public access servers on usenet that require no authentication). But in this day and age, security is key.
And of course missing the inter-server news exchange but for now it works fantastically and I just love that.
Whenever you have time you can rebuild the documentation, maybe once I have neared completion of my changes.
Don't want to do it for each PR ;).
Excellent! I accepted all changes and updated the PDF/HTML docs accordingly. Let me know if you have more fixes.
Will do!
I just noticed that both are profile pictures are pretty classy too. Just saying :)
Is there anything that the documentation is possibly lacking. As I think I have worked out atleast most of it. Just want to know if there is anything at all I could add to it. Any rough ideas?
Hm, I don't know, to be honest. However, from the developer perspective, it's bit difficult to tell sometimes. When you set up the server, did you had any trouble? Important questions that arose and that are not included in the docs?
It is difficult to tell from such a perspective. Maybe I will come up with something.