Re: Core Schematic Note link broken

Chris Dudley wrote:
> Daniel Fournier wrote:
> 
>> Hi,
>>
>> The Core Schematic Note link is broken on page:
>> <http://docs.xaraya.com/index.php>
>>
>> Cheers,
>>
>> Daniel
> 
> oops - fixed now - thanks.
> 
> Note that www.xaraya.com is being revamped soon and all the 
> docs.xaraya.com content will be merged into it at that time so we are 
> aware that docs.xaraya.com is slightly out of date and not that great a 
> site ;-)

That's an annoucement I like very much.

Beeing discovering Xaraya project, I heavily rely on documentation to be 
quickly in phase with its development (I plan to use it for specialized 
community sites I've to settle).

In my opinion, documentation is responsible, at least for a 50%, of the 
success of an inovative project (I think Xaraya is one of those in the 
rapidly growing Open Source CMS world). There lies the main weakness of 
the XUL technology I've been practicing for more than 2 years now and I 
whish to advise the Xaraya community not to be faced with this major 
handicap.

So, here are, out of the box, the first suggestions I'd like to post.

RFCs are great! They are references and should be constantly corrected 
and modified to be kept in pace with the project. Apparently this is not 
the case, there are errors and some RFCs are merely placeholders for 
upcoming specifications.

My wish is to see all RFCs incorporated in the docs site, formatted in a 
standard fashion and being commentable (every PHP developer knows the 
importance of a fully commented manual as provided by php.net, and 
personnaly, every time I've to write some PHP code, I load the inline 
PHP manual in one the tabs of my Mozilla browser). Quickly errors will 
be detected and corrected.

Another major source of documentation is the code itself. Browsing thru 
Xaraya code I was pleased to embrace a clear and modular organisation 
and to see many useful comments. This code is accessible in the PHP 
Cross Reference pages, something akin the Linux Cross-Reference pages 
used by Mozilla developers (yet I don't find the search feature which is 
so helpful to quickly find any reference).
It's a key feature, and it can be enhanced if it is incorporated in the 
docs site and made commentable too.

And last, the same commentability should be provided with "Xaraya 
Installation and Getting Started Guide" by Drew Vogel. Slice it in small 
commentable, cross referenced sections, and quickly it will be the 
authoritative users manual Xaraya needs (once again I'm refering to a 
fine example in the XUL community: XULPlanet <http://xulplanet.com>).

There's a lot of work to be done to satisfy these requests, but I'm sure 
you think they're worth while because they can push Xaraya far ahead of 
all others Open Source CMS.

Cheers,

Daniel