On 19/06/13 21:01, Corey Richardson wrote:
I am going to rewrite and redesign rustdoc. Current bikeshed:
https://github.com/mozilla/rust/wiki/Bikeshed-rustdoc
Please discuss, give me your feature requests, comments, etc.
_______________________________________________
Rust-dev mailing list
[email protected]
https://mail.mozilla.org/listinfo/rust-dev
I have had recent good experiences with the Sencha documentation (its a
Javascript framework): http://docs.sencha.com/extjs/4.2.1/#!/api
In particular:
- It has a search function that is actually useful - it matches what you
type in against language-specific items like class and method names
only, but it updates in real time rather than having to hit enter to
view the search results, and it is very fast. The search also works
offline because the dataset it searches is fairly small. For most
languages I google the documentation, but for Sencha it is actually much
faster to use the documentations built-in search.
- It has lots of information available (including user comments), but
most of it is hidden by default. I think this is nicer than, say,
JavaDoc, where instead of descriptions expanding in place there is a
list of method signatures and a separate list of detailed method
documentations.
- Everything is linked to everything else.
- It has a tree on the left where you can see everything, but only the
top level of the tree is visible by default.
I just want to chuck this out there as something that I really liked and
hope rust copies.
Cheers
Gareth
_______________________________________________
Rust-dev mailing list
[email protected]
https://mail.mozilla.org/listinfo/rust-dev
