Ben Sizer wrote: > Actually, I quite like the Elixir API docs, having had a chance to > read through them. It's just that you have to dig 3 or 4 pages deep > from the index before you see details on mapping your objects, etc. If > there can just be some enhanced visibility of these pages, it might be > enough.
Agreed, to a point. I think that API docs should be like this: nested. We really just need additional higher-level docs and improved tutorials that will give users an idea of how to get started, and then they can use the API docs more as a reference, rather than as the only way to figure out how to get things done :) > Just a suggestion though: I think there's a slight overreliance on > referring to other technology, like "model objects following the > Active Record design pattern, and using a DSL syntax". It's speaking > to experts rather than beginners. I think that these terms will mean > nothing to many people who are just getting started and may make them > think that using Elixir is a complicated and jargon-filled task, when > in fact it's very simple. And it tells you what it is, as opposed to > what it does. Agreed, again. Please move this discussion to the elixir mailing list, if you don't mind, as it doesn't really have anything to do with TurboGears :) Thanks! -- Jonathan LaCour http://cleverdevil.org --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/turbogears?hl=en -~----------~----~----~----~------~----~------~--~---
