perl-docs-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stas Bekman <>
Subject Re: Fwd: Re: [PATCH] docs/
Date Sat, 20 Apr 2002 16:13:11 GMT
Per Einar Ellefsen wrote:
> At 17:09 20.04.2002, Bill Moseley wrote:
>> At 03:23 PM 4/20/2002 +0200, Per Einar Ellefsen wrote:
>> >I sent Stas an index_top.html for the Documentation, containing some
>> >indications as to what to read. However, he told me he didn't want to
>> >commit it:
>> >
>> >>I didn't commit index_top.html. I think it's a bad idea to add it 
>> there.
>> >>Because you want to read this info only once. After that it gets on 
>> your
>> way,
>> >>since you have to scroll down to get to the real docs.
>> >>I thought to move it to the bottom, but it's probably not a good place.
>> >>Did you see what Bill has added? May be it should be merged there?
>> >>
>> >>Can you please raise this issue on the list and see what others 
>> suggest,
>> >>I'm out of ideas :(
>> >
>> >I guess we could make a separate page called "What to read" which could
>> >contain this information.
>> I think it's a good idea.  I haven't seen the text, but I can also see
>> Stas' point.  Could the top of the page have a simple link "What should I
>> read?" to a section at the bottom?

The text is very nice, but takes at least one page. Per Einar, can you 
please send it here (I can't find it)? Thanks!

>> For one thing that sentence "Tons of documents for you to learn from"
>> doesn't really fit, and I don't really see it, as my eyes just skip to 
>> the
>> first bold title.
> Well, that's how I feel too. I think some explanation is necessary, even 
> though it won't be read, because a seasoned reader will just skip it, 
> while someone coming for the first time can try and navigate for 
> himself, then come back if he didn't get it right.
> I think your idea of moving it to the bottom and adding a link is a good 
> one.

Me view is different. The /docs area is for heavy daily use and therefore
should be clean of noise. completely if possible. We have enough noise 
already with these
descriptions of each area. I'd even shorten this one. The titles are 
*very* descriptive already. But it's fine to keep as as they are.

it looks like /about is the area for newbies. Let's put the
"what should I read" there as a separate doc.

I'd even rename it to /start and put all kind of stuff for newbies to 
the site.
Stas Bekman            JAm_pH ------> Just Another mod_perl Hacker     mod_perl Guide --->

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message