Akelos Framework v1 forum archive. This forum is no longer maintained. To report bugs please visit https://github.com/akelos/akelos/issues
    • CommentAuthoralake
     

    I have been documenting and need a break. But I'd like to tell the community what I've been up to.

    I created a Table of Contents in the Wiki, just for a starting place. Because I was having a problem modifying a View, I decided to document Views. This documentation is under ActiveRecord | Views on the Wiki page.

    Here's where I could use some help from Mr. Akelos.

    One of the first entries is "Construction Notes". In it, I've listed the stuff from the API and noted what's been documented and what hasn't. I'd like to see the documentation for Akelos developers and for Akelos users separated. Some of the stuff for Akelos developers tells me that there are tools for users that also needs to be documented.

    I've written other Views documentation, adapting it from the API documentation. (Yes, I'm a native English speaker.) However, I'm still working on my first Akelos project.. I'd like to get a review of my work from experienced Akelos hands.

    Something that I'd like to ask the Community to consider. When a question is asked in the Akelos Programming forum, would you all consider answering the question by creating / improving documentation that answers the question and using the forum to point to the documentation and to explain things that would not be appropriate for the documentation. This will help to build the Wiki so that the parts that are used the most will be documented first.

    The main Akelos page notes that there are two programmers working on Akelos. One, of course, is Bermi. I don't know if the other is Salavert or Kaste. Anyhow, if the Community really wants to become impressed with some great programming, just get into the Akelos code and its API. The hat of this old timer (programming since 1968) is off to you guys.

    For now, I'm going to take a break from documenting and do some more Akelos programming.

    •  
      CommentAuthorbermi
     

    Alan my hat is off for your huge effort on creating, organizing and improving the Wiki docs.

    I will review the documentation you created in the Wiki – I'll have to take a week off to do so :).

    I can also review your current Akelos app if you drop me an email with the code or svn repo details.

    Thumbs up for the answering via Wiki docs suggestion. The forum buries to many interesting bits.

    FYI Salavert ported the helpers from Rails, Kaste is the most active developer right now doing major improvements and refactorings, and I've just added you as the Wiki master :)

    Your contribution will make it much easier for newcomers. Thank you!