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

Reference page documentation workflow proposal #63

Open
joeyklee opened this issue May 22, 2019 · 0 comments
Open

Reference page documentation workflow proposal #63

joeyklee opened this issue May 22, 2019 · 0 comments

Comments

@joeyklee
Copy link
Contributor

Just a thought about a workflow that might be good to implement regarding adding documentation the ml5-library and the website. I'd rather create less overhead so maybe this proposal doesn't make sense. Ideally we could have [jsDoc](https://devhints.io/jsdoc_ running at some point, but maybe this is a start?

for example: if we update sketchRnn:
Make changes to ml5-library/src/sketchRnn/index.js ==> update ml5-library/docs/api-sketchRnn.md ==> copy the contents of that file to ==> ml5-website-2/reference/api-sketchRnn.md

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

1 participant