Gamua / Starling-Framework

The Cross Platform Game Engine
http://www.starling-framework.org
Other
2.87k stars 826 forks source link

The Documentation APi? #723

Closed blackjyn closed 8 years ago

blackjyn commented 9 years ago

Please include the API in the repo like FeathersUI did . thanks

PrimaryFeather commented 9 years ago

I'll look into it, thanks for the suggestion!

blackjyn commented 9 years ago

:+1: , thanks for considering :)

honzabrecka commented 9 years ago

I'm against the suggestion. Repo shouldn't contain anything that can be compiled.

PrimaryFeather commented 9 years ago

I agree, Honza: I wouldn't put it in the repo, but some other place. I'm considering links to all zipped API references in the Wiki or on "doc.starling-framework.org".

honzabrecka commented 9 years ago

It would be cool if doc.starling-framework.org contained docs for all released versions (1.0, 1.1, ..., 1.7) and for master. Something like this:

doc.starling-framework.org/ -> doc.starling-framework.org/v1.7rc doc.starling-framework.org/master doc.starling-framework.org/1.0 doc.starling-framework.org/1.1

PrimaryFeather commented 9 years ago

Yes, I also think that would make most sense! Plus some place where people can download zips for offline usage.

PrimaryFeather commented 8 years ago

It's still very basic - but usable! ;-)

http://doc.starling-framework.org/archive/

You can access the reference for all versions back to v1.3, browse them online, or download a zip-file.