[IVY-274] and documentation for all

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.4-RC1
• Assignee: Xavier Hanin
• Reporter: Xavier Hanin
• Due: 17/Nov/06
• Created: 21/Aug/06 12:10
• Updated: 06/Oct/06 15:19
• Resolved: 26/Nov/06 07:05

Description

Ivy documentation suffers from several points which may slow down ivy adoption:

• the offline is very poor, only a single html page with links only to the online version
• the web site serving the documentation is slow
• updates can only be done online with appropriate privileges, which prevent some people to contribute more
• since the best (the least worse) documentation is online, update with latest feature are only done just before the release, to avoid users to get lost with features not yet released

The objectives of this improvement are thus:

• to deliver an offline documentation almost as good as the online one (but without comments)
• allow people to contribute to documentation through patches to an xml version of the doc
• investigate a way to improve web site performances
• investigate a way to host several versions of the documentation online