Home » U++ TheIDE » U++ TheIDE: Other Features Wishlist and/or Bugs » An idea for improved documentation
Re: An idea for improved documentation [message #14710 is a reply to message #14694] |
Mon, 10 March 2008 09:30 |
|
mirek
Messages: 13979 Registered: November 2005
|
Ultimate Member |
|
|
mdelfede wrote on Sun, 09 March 2008 06:23 | I think the best and the simplest (for now) would be to put upp docs in upp format on a svn server.
Converting them to Html should be quite simple, then, if we want to have html docs too. The way around (from html to upp) would be almost impossible.
Having docs in a simple format (even xml would be good) could make it possible to convert docs in many format.
What we need is a way to add docs from inside theide in a SIMPLE way, and a SIMPLE way (just a click...) to update a repository with it. No need to have same format in Upp and in repository, just some sort of easy-to-convert format (which is not the case of html).
The wiki could then be kept updated by simple scripts running daily.
|
You would not need to run scripts, just run existing website generator daily...
Quote: |
Example of a cycle :
1- you need a function that does something... you look in docs, none. You search in upp code (what for now happens often), and you find it undocumented.
2- just select some 'add doc to item' menu item, and than have an input dialog to add some docs.
3- press a button and update central repo
|
Yes. The only trouble I see is the "way back" - it should be possible update actual version of docs first, before making any changes.
Mirek
|
|
|
Goto Forum:
Current Time: Mon May 13 12:39:51 CEST 2024
Total time taken to generate the page: 0.02656 seconds
|