search

tidev / titanium-docs

We use VuePress for Guides and API docs.
https://titaniumsdk.com
Apache License 2.0
13 stars 23 forks source link

Alloy docs are missing #93

Open m1ga opened 2 years ago

m1ga commented 2 years ago

The old Alloy docs (https://docs.appcelerator.com/platform/latest/#!/api/Alloy) are not included in the current https://titaniumsdk.com/api/

The files are located at https://github.com/tidev/alloy/tree/master/docs

caspahouzer commented 2 years ago

+1

cb1kenobi commented 2 years ago

This is because the titanium-docs GitHub action that builds and deploys the site does not pull the latest doc content from the various repos (SDK, Alloy, modules, etc). It's on the radar. It's hard to determine what exactly is the priority, so this has yet to be finished.

m1ga commented 2 years ago

any news on the integration part? Would be nice to have it in the docs again for the next release

m1ga commented 2 years ago

still have no clue how to add the alloy docs. There is only a jsca file and some js docs, no yml files. If I remember correctly the old docs showed all animations (https://github.com/tidev/alloy/blob/master/Alloy/builtins/animation.js#L70-L77) but they are not listed in https://github.com/tidev/alloy/blob/master/docs/apidoc/builtins.js

Is https://github.com/appcelerator/doctools needed to build Alloy docs?

ewanharris commented 2 years ago

I can't fully remember how the Alloy docs got included in the old site and I'm not certain that they ever were included in this site.

If I remember right, jsduck would be ran over the JS files in the Alloy repo and use the JSDoc in those to then generate the required pages. Given that the jsduck is now no longer used maybe it would make sense to convert those files into TDoc yaml and use those in the generation script here similar to modules/sdk

m1ga commented 2 years ago

I think you are right, guess we'll need to convert them. Would make it easier in the long run