If you can get an established standard on what the content and format should be, I can work with you reviewing the patches and applying them.
But, need to get a concordance from the list on the content first. -Ross On Feb 19, 2010, at 10:53 AM, Stuart Roebuck wrote: > I've had a bit of a break from Lift and coming back I find myself > annoyed that I didn't write some notes last time and am having to go > back to searching through the various bits of documentation to figure > things out. > > Anyway, after much thought I decided that the best way to write my > notes would be to supplement the API docs (ie. the Scaladoc > documentation in the code base). so that I can view context sensitive > help in my IDE of choice and others can benefit from my labours! > > So, question 1… > > The current API docs are very light on documentation and sometime ago > I noticed some notice about removing documentation from the code > base. Is there some policy about not having documentation in the > code or any thought on whether it should adhere to the Scaladoc 2 > syntax? > > Question 2… > > This is only really going to work if the process of submitting the > documentation is reasonably straightforward so… What's the easiest > possible way of submitting documentation changes to the code base? (if > indeed this is something the core team would welcome). I was > thinking of perhaps emailing git patch files to someone in the core > team who can verify that the comments are right before checking them > in. Any thoughts? > > If there is a reasonably explainable approach, it could be added as a > Wiki page to encourage wider participation. > > Best, > > Stuart. > > -- > You received this message because you are subscribed to the Google Groups > "Lift" group. > To post to this group, send email to lift...@googlegroups.com. > To unsubscribe from this group, send email to > liftweb+unsubscr...@googlegroups.com. > For more options, visit this group at > http://groups.google.com/group/liftweb?hl=en. > -- You received this message because you are subscribed to the Google Groups "Lift" group. To post to this group, send email to lift...@googlegroups.com. To unsubscribe from this group, send email to liftweb+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/liftweb?hl=en.
