Mad Scientist wrote: >Tony Di Schino said: >> what is supposed to be *in* the readme, namely (and identified by the >> readme Contents): >> >> CONTENTS >> >> - INSTALLATION > >You're right. You shouldn't have to fish for installation hints in the >changelog. There should be information about where the install doc is in >the README file, or, at the very least, the install doc should be >contained withing the readme file since that is, by convention, the first >place anybody would normally look.
Yes, this is one of the things I'd like to have changed with our current documentation. Originally, the idea to go online docs was due to having diagrams, screenshots, etc. Unfortunately, nobody on the doc team has gone to that effort and therefore HTML documentation may not even be necessary anymore. We could even just have URLs in the documentation that link to images stored on the website.
Either way, there's a lot to be done on the docs, we just need people to help get it accomplished. I'm sure you wouldn't want the AC coders to stop and work on the docs for the next month to 2 months. Not to mention, I don't think you'd understand much of what they would write anyway. =P
HoundDawg Director, Web Development http://www.unitedadmins.com
_______________________________________________ To unsubscribe, edit your list preferences, or view the list archives, please visit: http://list.valvesoftware.com/mailman/listinfo/hlds_linux
