Deskshell Documentation

[Shizza M]

Hi Everyone,

The new direction for appjs has been very exciting, and my congrats to all concerned for the good work.

For my part I'd like to contribute more to the dev, but even though I've got some scripting skills I'm still a little out in the cold. 

So in order to get up to speed I need documentation, and I'll put my hand up to write some doco, and this will help me understand in the process.

What are the documentation topics needed?

1. Building cef

2. How to add new core functionality

3. How it works

4. How to connect to a server with websockets.

5. Offline storage.

What else?

[Kevin Ingwersen]

Hello there Shizza! :)

The deskshell is yet in the works - however, I think some of the topics needed for a doc are:

1. Building CEF

2. Building the appjs-binary

3. Choosing a backend (Advantages, disadvantages)

4. Short introduction to Webkit Remote Debug Protocol

5. How it works

6. AppJS API

7. Hello World!

If there is anything I forgot, then add it :)

--
You received this message because you are subscribed to the Google Groups "appjs-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to appjs-dev+...@googlegroups.com.
To post to this group, send email to appj...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

[ashish negi]

@Kevin Ingwersen 

Are we doing some changes in CEF ? so that everyone need to build it if one wants to build from scratch ?

 
On Monday, September 9, 2013 11:27:40 AM UTC+5:30, Kevin Ingwersen wrote:

1. Building CEF

[Simon Horton]

Hi All,

Lets wait a week for the new version to land then we will know more about its architecture. However this is an extremely good initiative lets fully document the new version when it lands. Github has a built in wiki so I suggest we can use that for the documentation since it is easy to share and edit like that.

The current version will still be working when we release the new one so you can continue using the current version for now.

/Simon

[Shizza M]

Hi Everyone, 

That looks like a good list Kevin.

I'll wait for /Simon's trigger to get going on the doco in about a week or so.

Cheers,

[Chris Banford [Webascent]]

Think the documentation might be something I could help a bit on as well, especially if you need a nice chart or graphic. (will have to wait on coding help until I get up to speed with the proj and actually build something).
-Chris

[Simon Horton]

This is really great. If 3-4 of us can create the documentation then that will really help others understand and get started with the project. Lets wait for Morteza Milani to compile a new version of AppJS, we can then install it and write the documentation as we are using it. Issues that come up can then lead to us re-writing or improving things.

/Simon

[Kevin Ingwersen]

Sounds about right :)!

[Shizza M]

/Simon, 

Can you grant me rights to edit the wiki for the project - I'll start a list of doco topics there which we can refine as we go.

Cheers,

Sholto

[Simon Horton]

Would love to but I don't have rights to do that :-( 

However I do have rights to edit the wiki itself, if you send me the changes I can copy them in, however I would like you to get credit for the changes you make so please ask Morteza Milani to give you rights to edit the wiki as well.

[Shizza M]

@Morteza Milani,

Hi Morteza Milani, 

If you grant me access to the wiki I will start to assemble a list of documentation topics for further documentation. 

But I will wait until Monday 16th, or when the binary has been built and announced as ready for testing.

I will also try to bring together some of the questions & explanations from the recent work on this list.

Cheers,

Sholto

[Simon Horton]

Hi Documenters!

I have created the first windows release for deskshell. Wiki is available here: https://github.com/sihorton/appjs-deskshell/wiki. From what I understand you should be able to edit the pages if you are logged into github. I have created pages for a ToDo list and then a Requested Features page.

Once the new binary for appjs lands then we will be able to use that as an alternative to chrome, reusing the api and debug api, but we can start with this windows release now.

You are more than welcome to play around and try to create some apps and document the problems and solutions you find when learning this new architecture.

/Simon

[sihorton]

I am getting close to a windows release of deskshell. It would be great to have some example html5 applications: webrtc, css3 transitions / animations and so on. This way we can test / prove that the new version fixes the issues we had with the previous version of appjs.

Also if anyone would like to help with the graphics / layout / design of the sample apps that would be very welcome.

/Simon