Re: [Chicken-hackers] [PATCH] Add "chicken.type" module

[Peter Bex]

On Fri, Sep 15, 2017 at 12:34:10AM +0000, Evan Hanson wrote:
> On 2017-09-11 19:04, Peter Bex wrote:
> > Now, does anyone want to look at what to do with the documentation?
> > The current "Types" manual page is quite well-written, but it's
> > structured like a tutorial which makes it less suited for the
> > reference manual style which we use for module documentation
> > in the rest of the CHICKEN 5 manual.  The same is true for the
> > bits on FFI and the module system.
> 
> Perhaps we should leave the content of these pages alone, but move the
> documentation for specific procedures and macros into separate pages that
> correspond to the modules they live in? As you say, the current docs are
> well-written and effective as tutorials and big-picture explanations, but a
> clear separation between "user guide" and "procedure reference" might do us
> well. Then the user guide pages can link through to the relevant procedure- 
> and
> and macro-specific docs wherever they're mentioned.
> 
> So, we'd have something like:
> 
>  - manual/Types
>  - manual/Modules
>  - manual/Foreign Interface
>  - manual/Module (chicken foreign)
>  - manual/Module (chicken module)
>  - manual/Module (chicken type)
> 
> Thoughts?

That could work, probably with only minimal changes to ensure we don't end
up with duplicate procedure "reference definitions".

Cheers,
Peter

signature.asc
Description: PGP signature