Hi Josh, On Fri, 2012-02-03 at 13:26 +1030, Josh Heidenreich wrote: > I was bored while waiting for LibO to compile, and I was taking a look > at the wiki docs for development. I found a page "Code Overview", but > it looks really out of date.
It is ! :-) > (http://wiki.documentfoundation.org/Development/Code_Overview). Then I > thought maybe I should update it, and then I thought it would be > better to do it using software. Agreed; personally I'd really prefer the authoritative source of that information to be in git. > It uses cgit to download the README or readme.txt files in all of the > top-level directories, and it generates some HTML files for easy > viewing. The first paragraph (everything before an empty line) is > considered the "short description", and is shown on the list page. > Clicking on a module shows the full description, as well as a link to > the tree in cgit. Lovely. I guess having some (really minimal) formatting in READMEs, and working to standardise it would be extremely helpful: first line, "short description" next line (to new-line) longer description, then more gutsy stuff ? > Now of course all we need is to add more README files. What would be really sexy (apart from getting your script running on a TDF server and linked from the wiki etc. etc.) - would be if we could transfer what little information we have from the Code_Overview into README files. Any chance you could clone the git repo from freedesktop, and send a git diff with that text in README files ? Thanks so much for helping to improve this, it is much appreciated ! :-) there is lots to do at the intersection of the web and the git repo, a random example would be the "find code from UI" feature that I'd love to get setup [ be nice if it could be used locally on a repo too ;-]. All the best, Michael. -- michael.me...@suse.com <><, Pseudo Engineer, itinerant idiot _______________________________________________ LibreOffice mailing list LibreOffice@lists.freedesktop.org http://lists.freedesktop.org/mailman/listinfo/libreoffice