Hi Eric.
Post by Eric BarnhillI am interested in adding some documentation to the commons Complex user
guide visible at
http://commons.apache.org/proper/commons-numbers/commons-numbers-complex/index.html
. I was wondering if this is available to edit through the commons git
mirrors somehow? Apologies if this information is presented somewhere
obvious.
I've added the missing file:
https://git1-us-west.apache.org/repos/asf?p=commons-numbers.git;a=blob;f=commons-numbers-complex/src/site/xdoc/index.xml
Format is "xdoc".
It's a good place to explain the design and/or give some short
examples of API usage.
For more elaborate use-cases, we might want to create a special
purpose module (like for "Commons RNG") that contain fully
functional codes but not subject to the backward compatibility
constraint of the official codebase.
A longer-term documentation project could be to start a standalone
user guide that would contain one section per module, that would be
linked from the top-level web site, similar to
http://commons.apache.org/proper/commons-rng/userguide/index.html
There is a "skeleton" for this here:
https://git1-us-west.apache.org/repos/asf?p=commons-numbers.git;a=tree;f=src/site/xdoc/userguide
(not yet linked from the web site's homepage).
Regards,
Gilles
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-***@commons.apache.org
For additional commands, e-mail: dev-***@commons.apache.org