Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alloy docs are missing #93

Open
m1ga opened this issue Mar 18, 2022 · 6 comments
Open

Alloy docs are missing #93

m1ga opened this issue Mar 18, 2022 · 6 comments

Comments

@m1ga
Copy link
Contributor

m1ga commented Mar 18, 2022

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
Copy link
Contributor

+1

@cb1kenobi
Copy link
Contributor

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
Copy link
Contributor Author

m1ga commented May 2, 2022

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

@m1ga
Copy link
Contributor Author

m1ga commented Jun 30, 2022

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
Copy link
Contributor

ewanharris commented Jul 4, 2022

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
Copy link
Contributor Author

m1ga commented Jul 4, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants