Artur Hefczyc wrote:

We need some basic documentation for the project

What kind of documentation are we talking about? This is utility project so… javadock-ing everything would make most sense…

and source code on either wiki page or ASCII doc format.

Isn't source view in https://projects.tigase.org/projects/tigase-utils/repository not enough? Or source of the documentation?

Wojciech Kapcia wrote:

Artur Hefczyc wrote:

We need some basic documentation for the project

What kind of documentation are we talking about? This is utility project so… javadock-ing everything would make most sense…

Each public project should have:

1. Very brief project description on the project overview page

2. At very least, some more detailed description of what is inside and how this can be used (like in this case).

3. If it makes sense more detailed description with examples code, configuration, etc.... (not necessary in this case).

and source code on either wiki page or ASCII doc format.

Isn't source view in https://projects.tigase.org/projects/tigase-utils/repository not enough? Or source of the documentation?

I meant "basic documentation for the project and source code". I mean some basic description of what is inside the library, what kind of stuff is there for people to use. Like, JID manipulation code, String prep logic, DNS resolver for IPv4/IPv6, etc... Just top level information of what kind of utility code people can find here.