[augeas-devel] [PATCH] Add naturaldocs support

[David Lutterkort]

On Sat, 2008-09-13 at 10:54 +0200, Raphaël Pinson wrote:
> 
> 
> On Sat, Sep 13, 2008 at 2:38 AM, David Lutterkort <lutter at redhat.com>
> wrote:
>         On Fri, 2008-09-12 at 16:38 -0700, David Lutterkort wrote:
>         > Now I just need to figure out how that should appear on the
>         website ;)
>         
>         
>         To get something up on the site, I linked the docs from the
>         'Documentation' section[1]
> 
> 
> That looks very nice :)
> In the API documentation, there should be a way to change the title of
> the pages for the files (it says
> "/home/lutter/code/augeas/src/augeas.h"). That's a detail though.

Haven't even noticed that - but yeah, that should change.

> Also, I wonder if it would be nice to add the links to the main
> website like I did in the beginning, or if it would just make it
> heavier...

Yes, we definitely need backlinks. But I think rather than show the
whole menu from the main site, we should just have one or two links: one
to the main site, and one to the Documentation section on the main site.

I think the whole menu will be too heavy.

> Another thought: now that we separate the C API from the lenses for
> documentation, there is no need to use "view" to declare lenses since
> it won't conflict with C declarations. Do you think "view" is a good
> keyword for it, or rather "define", or something else [0]?

Yeah, I would either make that 'Define' or 'Lens'; I don't think that
using 'View' there is all that clear.

David