Documentation

[Sebastian Riedel]

For those not following me on Twitter, i'm currently working fulltime on Mojolicious documentation and have already started to commit some of it.

http://github.com/kraih/mojo/commit/66267f1d30d2acf477ed591b297c3bd8abd79b76

Feedback and possibly patches would be appreciated.

--
Sebastian Riedel
http://labs.kraih.com
http://mojolicious.org
http://twitter.com/kraih

[David Davis]

Look'n good!  We can always use more docs.

David Davis
☄ Software Engineer
http://xant.us/
http://xantus.tel/

--
You received this message because you are subscribed to the Google Groups "Mojolicious" group.
To post to this group, send email to mojol...@googlegroups.com.
To unsubscribe from this group, send email to mojolicious...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/mojolicious?hl=en.

[Yuki Kimoto]

Is Minimal Route first example's controller class bye methods wrong?
welcome method is maybe right.

# Wrong
sub bye {
my $self = shift;

# Render response
$self->render(text => 'Good bye!');
}

# Right
sub welcome {
my $self = shift;

# Render response
$self->render(text => 'Welcome!');
}

2010/6/15 David Davis <xan...@xantus.org>:

[Sebastian Riedel]

> Is Minimal Route first example's controller class bye methods wrong?
> welcome method is maybe right.

Thanks, fixed.

[Sebastian Riedel]

Btw. i have just the first few chapters planned out yet, so there is still some room.
I'm really interested in what you think i should write a guide about.

Ideas? :)

[Ilya Skorik]

The real application will be the best guide. For example a miniblog app with sqlite and user authorisation through cookie. With sessions, i18n, comments and image uploads.

The minimum possibilities, minimum of a code and usage of the best practice. This my opinion.

2010/6/15 Sebastian Riedel <kra...@googlemail.com>

[Sebastian Riedel]

> The real application will be the best guide. For example a miniblog app with sqlite and user authorisation through cookie. With sessions, i18n, comments and image uploads.
>
> The minimum possibilities, minimum of a code and usage of the best practice. This my opinion.

I expected this to come up sooner or later and i have to say that i strongly disagree.
We don't need more examples (at least none written instead of actual documentation), there are many on github already, doing pretty much everything you listed.

Here's a good overview of what i'm aiming for.

http://jacobian.org/writing/great-documentation/what-to-write/

So far we have Tutorials and Reference well covered, so i'm focusing on Topical Guides.

[Dotan Dimet]

Things for topic overviews:

How about a guide to the template rendering flow - a good explanation of
how all the little fiddly bits hook together when templates are
rendered: template names and named routes, what does the default handler
do, when a template in the template_dir is picked up vs a template in
the data section, partial rendering (layouts), what all the reserved
keywords in the stash and what are they used for, etc.

Also, template rendering isn't just Ep - the guide should explain what
features are only in Ep and what are available elsewhere (for example,
the Haml renderer has helpers, the TT one doesn't).

- Dotan

--
This message has been scanned for viruses and
dangerous content by MailScanner, and is
believed to be clean.

[vti]

TT renderer has helpers too!

but in my git branch... :)

[Sebastian Riedel]

> How about a guide to the template rendering flow - a good explanation of how all the little fiddly bits hook together when templates are rendered: template names and named routes, what does the default handler do, when a template in the template_dir is picked up vs a template in the data section, partial rendering (layouts), what all the reserved keywords in the stash and what are they used for, etc.

Funny, i'm working on this guide right now. :)

[Yuki Kimoto]

I think up　the following topics.

Rendering and Template
Offten Used Utilities(Mojo::Message::Request, Mojo::Log, MojoX::Type,
Mojo::Home etc)
Session(session, flash, etc)
Plugin system(before_dispache, add_helper, etc)
Testing
Deployment(Single server, Prefork server, CGI, or Fast CGI, PSGI, mod_perl)
HTML5 Features(WebSocket, etc)
Advanced Features(SSL support, Performance, etc)

2010/6/15 Sebastian Riedel <kra...@googlemail.com>: