#3 Documentation is out of date

[Kolja Waschk]

At least the Changelog, THANKS and list of supported devices are not up to date for 0.6 and have to be updated. Where appropriate, URLs should now point to the UrJTAG project rather than to openwince.

For future releases, documentation could be maintained in the Wiki. A synchronization from Wiki to SVN doc/ could be done immediately before a release.

[Kolja Waschk]

Logged In: YES
user_id=478715
Originator: YES

Also see [1837364] Install instructions wrong

[Kolja Waschk]

Logged In: YES
user_id=478715
Originator: YES

Added trunk/jtag/doc/doc-layout.txt, a layout draft for comprehensive documentation.

I'd rather write the documentation in the subversion repository and create HTML pages from there for the web site. The Wiki as it is provided by SourceForge is much too slow (100+ items to load for a single page!) and cannot be configured to render lists correctly (font is 85% for each sub-list, which quickly becomes unreadable).

[Kolja Waschk]

Logged In: YES
user_id=478715
Originator: YES

In an attempt to use DocBook for the documentation, I created doc/UrJTAG.xml which incorporates the old README, Ralf's Wiki pages and some new lines of text. Not sure if all documentation should go this way (what about COPYING, AUTHOR, THANKS, TODO?). On the other hand, documentation should not have to be maintained in more than one place, and from DocBook we could easily create HTML and PDF etc... I'll attach a sample PDF created from UrJTAG.xml rev 799

[Kolja Waschk]

Logged In: YES
user_id=478715
Originator: YES

AUTHORS and THANKS has been updated.

Info from README and README_21065L went into doc/UrJTAG.xml.

UrJTAG.xml has been reformatted for asciidoc processing and is now the main documentation for UrJTAG.

There are still details to fix and sections to complete but at least the documentation is up to date.