[jira] [Commented] (GEOMETRY-73) Create User Guide

["Matt Juntunen (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/GEOMETRY-73?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16994151#comment-16994151 ] 

Matt Juntunen commented on GEOMETRY-73:
---------------------------------------

I'm working on this here: [https://github.com/darkma773r/commons-geometry/tree/geometry-73-working]

 

How much leeway is there in terms of the formatting and structure of the user guide? For example, I'm not a fan of the layout of the [commons-rng guide|http://commons.apache.org/proper/commons-rng/userguide/index.html], where the table of contents is on a separate page from the actual contents. It's hard to navigate that way. I'd much rather put it all on one page like [velocity|http://velocity.apache.org/engine/devel/user-guide.html] does. Also, the commons-rng guide uses apt as the source format, which doesn't appear to support source code formatting like xdoc does. Can I use xdoc instead?

> Create User Guide
> -----------------
>
>                 Key: GEOMETRY-73
>                 URL: https://issues.apache.org/jira/browse/GEOMETRY-73
>             Project: Apache Commons Geometry
>          Issue Type: Task
>            Reporter: Matt Juntunen
>            Priority: Major
>             Fix For: 1.0
>
>




--
This message was sent by Atlassian Jira
(v8.3.4#803005)