documentation requests/questions

General discussion about 3D DCC and other topics
User avatar
Hirazi Blue
Administrator
Posts: 5113
Joined: 04 Jun 2009, 10:15

documentation requests/questions

Post by Hirazi Blue » 24 Apr 2011, 20:08

These are two things that have been bugging me for a long time
(not something specific to the newest incarnation of the documentation):
1) Would it be possible to extend the index function of the docs to include the "Reference" chapters?
2) Why do the docs divide the ICE Reference into Nodes and Compounds? It would be way more practical (IMHO) to follow the organization in the ICE Tree preset manager, grouping nodes and compounds together based on their functionality.
;)
Stay safe, sane & healthy!

grahamef
Posts: 281
Joined: 23 Jun 2009, 19:01

Re: documentation requests/questions

Post by grahamef » 26 Apr 2011, 17:16

1) When the ref sections were converted from WinHelp to CHM format and merged with the rest of the docs, we deliberately left out the index entries because they were so bad that they almost would have made things harder to find. So far we haven't systematically gone through and re-indexed, although I believe that a few topics have had index entries added. It's a matter of finding the time -- so far new features, video tutorials, etc., have had higher priorities.

2) It was easier that way for v1 :). The original version of the ICE ref docs were automatically generated, from code headers in the case of nodes and XML files in the case of compounds. Now the docs are maintained independently and we've talked about reorganizing like you said, but again it's a question of finding time.

User avatar
Hirazi Blue
Administrator
Posts: 5113
Joined: 04 Jun 2009, 10:15

Re: documentation requests/questions

Post by Hirazi Blue » 26 Apr 2011, 17:40

Thanks for your reply... :ymhug:
Stay safe, sane & healthy!