Up-to-date and reliable documentation

What I really expect from Corona SDK in the near future is some reliable documentation. It is getting old and tiresome to second guess the documentation everytime I need it.
I find myself searching the forum and blog posts to find the correct answers for my questions, often finding conflicting answers and having to test them all.

Please consider updating the documentation along with daily build releases! [import]uid: 79152 topic_id: 21541 reply_id: 321541[/import]

it seems you’re moving further away from communicating with us developers, with empty descriptions on the daily builds, such as http://developer.anscamobile.com/release/2012/739 and http://developer.anscamobile.com/release/2012/738 :frowning: [import]uid: 79152 topic_id: 21541 reply_id: 85282[/import]

We are working on drastically improving our documentation and it will be happening soon.

A completely new system, so please stay patient, we are very aware of how badly this needs doing [import]uid: 84637 topic_id: 21541 reply_id: 85346[/import]

+1 for offline thing! [import]uid: 89165 topic_id: 21541 reply_id: 85386[/import]

I was thinking to use it with IDE (so need specific format, like LuaDocs tags) not just to browse it as html file [import]uid: 111283 topic_id: 21541 reply_id: 85389[/import]

+1 for offline as well! That would really come in handy. [import]uid: 58885 topic_id: 21541 reply_id: 85391[/import]

In the meantime I got all the doco and answers I could find and used PRINT TO PDF to add them to my iPad for reading offline :slight_smile: [import]uid: 10389 topic_id: 21541 reply_id: 85430[/import]

It wouldn’t be a bad idea to move the Corona documentation to a wiki engine, so that Corona staff AND developers (at least pro devs) could update it often (as well as adding insights and other details). [import]uid: 9158 topic_id: 21541 reply_id: 85474[/import]

Hey,

I have a question to both users and Ansca team. How we can (using pearl script or Lua as an example) take detailed information Not only about API file list (which is quite easy) but also about rest of data from this site:

https://developer.anscamobile.com/resources/apis

As example what is shown on page and can be read:

https://developer.anscamobile.com/reference/index/mediaplaysound

Description:
Syntax:
Example:
Parameters:
Returns:
Remarks:
Related:

which is equivalent of LuaDoc:

--- Name of our beloved function  
-- description  
-- description  
-- description   
-- @param1 param1 Description  
-- @param2 param2 Description  
-- @return returnValue  
-- @usage ExampleContent  
-- @see Related Links  
function module.functionName(param1, param2) return "whatReturn" end  
  

and that would be all. This works great with Lua for IDEA plugin without any need to document anything in html file or other files…

If this is possible create link to such text file on every page. Then users can use standard “get API script” to read content not just display.newImageRect() without anything useful. This information is already on the site anyway…
maybe we should make a small community project to achieve that ? everyone takes 20 functions to describe and in no time we have fully documented SDK. Then using Lua it can be converted to any specific format required if somebody like to see offline docs. This can be done by LuaDoc engine very simple.
Regards,
Tom [import]uid: 111283 topic_id: 21541 reply_id: 85651[/import]

I’ve started one here:

http://anscacorona.wikia.com/wiki/Ansca_Corona

If you’d like to help flesh it out, join and be my guest! :slight_smile:

If Ansca decide later to create their own hosted Wiki service we could copy a lot of the data already created across and it would help them speed things up a lot :slight_smile: [import]uid: 10389 topic_id: 21541 reply_id: 86717[/import]

Wouldn’t be cool to have one wiki page for standard docs and second special for LuaDoc friendly ? to be able to download it using proper pearl script ?

Regards
Tom [import]uid: 111283 topic_id: 21541 reply_id: 86718[/import]

Sure. If you find one let me know :slight_smile: [import]uid: 10389 topic_id: 21541 reply_id: 86731[/import]

I have done it. Not 100% completed but most of API should work.

https://github.com/tomBladko/coronaBladko/wiki [import]uid: 111283 topic_id: 21541 reply_id: 86843[/import]

I will +1 access to the documentation being accessible offline also.

Most of my time spent working with Corona is during travel, with no internet access. For now I’ve saved numerous pages of interest, but that’s not sustainable, and I can’t see any reason why adequate documentation for offline use is not available - especially to those who have upgraded. It’s something I’m holding off for. [import]uid: 110262 topic_id: 21541 reply_id: 87202[/import]

if we sum all the time we spent on asking Ansca for documentation update and use it to prepare our own documentation … i am sure this will give better result :wink:

Regards
Tom [import]uid: 111283 topic_id: 21541 reply_id: 87257[/import]

it’s good to hear from you all. Glad to hear the docs are changing and that people are colaborating to something better
i’ll be joining the task force [import]uid: 79152 topic_id: 21541 reply_id: 89060[/import]