On Sat, May 26, 2012 at 8:10 AM, Paul Merlin <[email protected]> wrote:
> I just finished a large serie of documentation related commits.

Awesome!!

> - an always present link to the sources and distributions

Specifics? A "Download" section at the top? (Getting crowded)

> - more recipes

Suggestions please!!! I have asked for this many times.

> - remaining libraries and extensions documentation

Yes, this is pure raw effort...

> - better table style (see News)

:-)  I am not CSS fluent...

> - integration of the dev-status.xml file

Yes, would be nice. I guess this requires a combo of AsciiDoc output
as well as CSS styling. I think I can manage this, since I already
read the dev-status in the build system to determine if a lib/ext is
to be part of a release.

> - copy/paste classpath specification for all examples and on

Generated from build system?? Wow!

> libraries/extensions page would be nice, maybe using the published groupIds
> and artifactIds

Please elaborate. Not sure I get what you have in mind. A Maven
<dependency/> snippet on each lib/ext doc page would be good to have
in anyway, but I get the impression you want to have some "overview"
page for them all.


> The documentation system that you cooked up Niclas is really nice. The local
> website generation is not so long, around a minute here, and it's a breeze
> to write in plain text files and get that result.

Yes, once the toolchain works locally, it is quite smooth.

> However, the Tutorials and Core sections are still a bit messy.

I totally agree! But it was hard to try and organize before any
reasonable style produced a readable output. Should be a lot easier
now to experiment.

> I tried to get the sub-nav TOC to go one level deeper without success

Gosh, I have spent a day on that, to no avail. Perhaps we should
contact the guy that made the XSLT in the first place.

> Niclas, do you think it would even be possible?

I am sure it is possible, it is more a matter of whether one have
enough XSLT (and DocBook XSLT) sorcery skills.

> The website at http://www2.qi4j.org is up to date. Please guys, review and
> provide feedback. What's good, what's not so good, what do you think is
> missing, what would you like to be added etc ...

Changing the link is fairly quick (<1 hour), so I will write up a
short news article to that effect, and then do the swap. We have
fairly short DNS timeouts (in fact too short to be a "nice" player on
the Internet, I think it is 20mins) so propagation should be quick.


Cheers
-- 
Niclas Hedhman, Software Developer
http://www.qi4j.org - New Energy for Java

I live here; http://tinyurl.com/3xugrbk
I work here; http://tinyurl.com/6a2pl4j
I relax here; http://tinyurl.com/2cgsug

_______________________________________________
qi4j-dev mailing list
[email protected]
http://lists.ops4j.org/mailman/listinfo/qi4j-dev

Reply via email to