royale-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Andrew Wetmore <cottag...@gmail.com>
Subject Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)
Date Fri, 26 Jan 2018 00:07:17 GMT
Hi:

I think the "Royale in 10 Minutes" goes where the ToC "Hello, World!" is in
the "Get Started" section. I saw the "Create an Application" section as
what you would turn to when you had gone through building a first little
application and decided, yes, maybe this Royale is the thing I need for
what I want to build.

I took the "application lifecycle" lineup from the old Adobe Flex help doc
structure [1] section "Application Architecture / Application development
phases". Of course, the under-the-hood tick-tock of what happens in a
Royale app when you run it is equally valuable, but different. Feel free to
use "Application Lifecycle" to describe what you want to write about, and
we can change the top title for my stack to something like "Application
development phases", as you suggest.

Each night I wake up at least once thinking something like, "Oh, I forgot
an entry for Events!" The ToC is far from complete!

I have added the info about the Apache header in README.md, which I take to
be the place where documentation contributors would look for guidance. Just
pick a time and let me know and I will be out of the way for your sweep
through the existing files. I am in Nova Scotia in Canada, four hours ahead
of you if you are on the West Coast.

a


[1] https://help.adobe.com/en_US/flex/using/index.html


On Thu, Jan 25, 2018 at 7:14 PM, Alex Harui <aharui@adobe.com.invalid>
wrote:

> Hi Andrew,
>
> So I just pushed more stubs for the Create An Application section.  As I
> was doing so, I started thinking that what you expect in that section is
> different from what I'm interested in working on.  It isn't that we don't
> need that section, but it appears that you want to address application
> development as a general topic, discussing the design phase, and
> maintenance phases, etc.
>
> What I want to write is a "Royale in 10 minutes".  Sort of a tutorial for
> building something more than a Hello World, and discuss some
> "under-the-hood" things like how the app starts up, how you know the app
> is ready, calling a web service, stuff like that.  If you agree we want
> such a thing, where would it go?
>
> Also, we have to be a bit careful about terminology.  The reason I
> initially thought that I would do the "Royale in 10 minutes" in the
> "Create an Application" section is because one subsection is titled
> "Application Lifecycle".  To me, that meant the under-the-hood lifecycle
> of an application like what its entry point is, what gets initialized
> first, etc.  I'm tempted to rename the current "Application Lifecycle" to
> "Application Development Phases" so I can use "Lifecycle" for the
> under-the-hood section.  Or is there a better name for how an application
> starts up?
>
> I'm going to go spend some time on ASDoc while we figure this out.
>
> Also, at some point, we should sweep through all of the files and add the
> Apache header to them.  I did it in "Create an Application.md" to make
> sure it didn't pollute the output.  I didn't do the sweep now since I
> didn't know if you have files under edit.  I'm not sure what hours you are
> working on this, so we should just pick a time where we have everything
> committed and do a sweep.  I could do it on my Sunday night on the US west
> coast.
>
> Thoughts?
> Alex
>
> --
Andrew Wetmore

http://cottage14.blogspot.com/

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message