                                                                                                                                                                                                                                                                
Received-SPF: pass (google.com: domain of funkat...@gmail.com designates 209.85.220.205 as permitted sender) client-ip=209.85.220.205;
DomainKey-Signature: a=rsa-sha1; c=nofws;
        d=gmail.com; s=gamma;
        h=mime-version:in-reply-to:references:date:message-id:subject:from:to
         :content-type:content-transfer-encoding;
        b=TxFs2DKMCpDaqyUaJtbAUui5jx4N+p8ePTGrOHH781hzapTO0PaFIk9WSbTjtJx038
         we+t0MrwH70Ur5pKtnqEvfGHqECGsfKKAUxgbMRWzXQFcIj/BNbU7fCeNHK0gQsPa3Ih
         na5FGj+a8Z8u4aG3OsEJELmRUYO29YiBOo15s=
Mime-Version: 1.0
Content-Type: text/plain; charset=UTF-8
In-Reply-To: <c6a0b72e0908121547q22dde225h9416a98d47e50...@mail.gmail.com>
References: <f5955f26-fb23-45c5-969f-c6d7f3f16...@i8g2000pro.googlegroups.com>
	 <5e0220e30908111105n5dcfc89fic5ad59d92125a...@mail.gmail.com>
	 <3c374da8-31a1-44b6-8d29-66df84c4b...@q40g2000prh.googlegroups.com>
	 <5e0220e30908120654j3281308cve8300de8dbd71...@mail.gmail.com>
	 <c6a0b72e0908121453k6a985648m8682dca1cece9...@mail.gmail.com>
	 <5e0220e30908121506t2efe9788g4c63e9a93c4af...@mail.gmail.com>
	 <c6a0b72e0908121514w141c8d3ft54c7bf6956b79...@mail.gmail.com>
	 <5e0220e30908121531r59209ca9y3c151297e7f37...@mail.gmail.com>
	 <c6a0b72e0908121547q22dde225h9416a98d47e50...@mail.gmail.com>
Date: Sun, 16 Aug 2009 21:30:05 -0400
Message-ID: <5e0220e30908161830k30b5272ay1dd39ecf97a6f...@mail.gmail.com>
Subject: Re: Documentation Assistance
From: Ed Finkler <funkat...@gmail.com>
To: spazcore-dev@googlegroups.com

No, there is not. The current document was really a "brain dump" of
what SpazCore is and how it relates to Spaz, some basics about what it
consists of, and what we should be working on. It's a bit out of date,
and certainly could use a lot more detail. There's also almost no
detail about coding or examples.

Of the target audiences, I'd rank #2 and #3 as most important,
followed by #1. #4 isn't something I'm *actively* pursuing at this
time.

--
Ed Finkler
http://funkatron.com
Twitter:@funkatron
AIM: funka7ron
ICQ: 3922133
XMPP:funkat...@gmail.com




On Wed, Aug 12, 2009 at 6:47 PM, Augustina Blair<missaugust...@gmail.com> wrote:
> OK that makes sense. I'd noticed there was a section about how to build Spaz
> and that seemed more appropriate for developer content, which is why I
> asked. For the developer wiki on GitHub, is there a particular table of
> contents structure that already exists somewhere? There are several items on
> the "Home" page. I can start going through those things and propose a
> structure based on what's there to the list. Folks on the list can fill in
> any blanks and make comments.
>
> Who is the target audience for this material? Here are some of my ideas:
>
> - A developer who is curious about how Spaz is built and just wants an
> overview.
> - A developer who wants to contribute to the Spaz project and needs to know
> enough to get started and where to contribute.
> - A developer who wants to contribute a specific feature or functionality to
> Spaz. They may or may not be familiar with Spaz's API, but they know enough
> about how Spaz works to know what they want to contribute.
> - A developer who wants to use a specific part of Spaz's implementation for
> their own application.
>
> Augustina
>
>
> On Wed, Aug 12, 2009 at 3:31 PM, Ed Finkler <funkat...@gmail.com> wrote:
>>
>> That is stuff specific to the desktop app.
>>
>> SpazCore is a set of components we're using for the basis of different
>> versions of Spaz. It could also be used in other apps, though.
>> SpazCore is really only of interest to developers.
>>
>> Spaz itself is multiple applications, currently a desktop app and a
>> mobile app for webOS.
>>
>> The existing "Spaziki" really only covered Spaz desktop. I would like
>> FAQ/KB-ish stuff about desktop to go into Tenderapp. I can give you an
>> account there if you like. Developer-oriented stuff about the desktop
>> app can stay in Spaziki for now, but should eventually be migrated to
>> Github's wiki when we move to that from Google Code's SVN hosting.
>>
>> Graeme suggests that end-user documentation that isn't of the FAQ/KB
>> variety should not go in Tenderapp. I sort of agree, and think some
>> kind of proper help docs should be put together. I am not sure where
>> they should go at the moment.
>>
>> --
>> Ed Finkler
>> http://funkatron.com
>> Twitter:@funkatron
>> AIM: funka7ron
>> ICQ: 3922133
>> XMPP:funkat...@gmail.com
>>
>>
>>
>> On Wed, Aug 12, 2009 at 6:14 PM, Augustina Blair<missaugust...@gmail.com>
>> wrote:
>> > I noticed there were topics covered in the "Spaziki" [1] that weren't in
>> > the
>> > Github wiki, unless I'm mistaken and I just didn't find it. In
>> > particular
>> > the "Customizing Spaz" section didn't seem to be addressed in the GitHub
>> > wiki. Is this stuff that you want to keep around? If so, should it go
>> > over
>> > to the GitHub wiki? Or would you like an entry in the tenderapp FAQ with
>> > some of this information? That entry could point to the GitHub wiki for
>> > further information.
>> >
>> > [1] http://funkatron.com/spaziki/
>> >
>> > >
>> >
>>
>>
>
>
> >
>