[Chandler-dev] Re: More documentation about the repository?

[Ted Leung]

On Jun 29, 2006, at 4:08 PM, Andi Vajda wrote:

>
>> I think the document should answer a few basic questions, and  
>> could be
>> pretty short, and written on a high enough level so that it does not
>> become obsolete in every release:
>>
>> * What is the repository, a paragraph introduction
>> * Pretty high level requirements/goals, including performance targets
>> * What software modules does the repository consist of, with brief
>> explanation of how each is used
>> * Core concepts and objects (kinds, items, attributes, monitors,
>> watchers, views, ...)
>
> Sounds great. Would you like to get it started ? Documents about  
> some of the topics you suggest are already available in various  
> places such as the chandlerdb blog, epydoc, or more or less  
> obsolete documents on the wiki.
>
> If someone volunteered to get it started and structured, I would  
> definitely review, edit and enhance it. The hardest part is with  
> getting it started and keeping it useful.

Could we use your Europython slides as a starting point?   Does it  
have some of the content that Heikki mentioned?

Ted