betty
betty copied to clipboard
Autogen doc
Add auto-generated documentation. Note that 91.92 % is undocumented.
Suggestion on documenting each module in lib or other *.rb here we say what does this *.rb does. task:, Author:, Date:, Copyright: I'll manage to develop a website for both betty and its documentation either in jekyll(this way we can run it on Github server) or in Sinatra(this way i push it on betty.herokuapp.com). What do you think?
@pickhardt Need you to participate here.
I will have to spend more time looking at this thoroughly. From my glance, I like the idea of having a site and documenting how stuff works. I would want to use Github for static page hosting (https://pages.github.com/) since we're already on Github already, it is way easier than using Heroku just for this.
@pickhardt Agree. Since betty is on Github, so hosting it on GitHub makes much more sense. At my glance we could use heroku to code a functional website with Sinatra, Rails, etc. and have backend in SQLite to manage some future stuff.
Can you explain more what you would do with Rails and a DB?
You know, the range of commands that Betty should cover is so much so having a DB on Betty's website backend makes it easy to let others add new module and other stuff automatically. When a user uses Betty it first checks that DB to see is there any new functionality to add and if so Betty updates itself to cover more functionality. Just note that useful commands are so much and reviewing pull requests take so much time. I believe that these kinda apps need to update themselves. Note that Betty can learn from users too. In DB schema we can have those commands supplied by user and original ones and we can run test suite related to those commands(supplied by user) and whenever the tests goes well so we add it to original commands.
@pickhardt What do you think?