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.

Sign up for GitHub

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

Jump to bottom

Create a documentation generation system #28

Closed
fkling opened this issue Nov 1, 2014 · 1 comment
Closed

Create a documentation generation system #28

fkling opened this issue Nov 1, 2014 · 1 comment
Labels
enhancement
Milestone
v0.3: conversion ...

Comments

@fkling
Copy link
Owner

fkling commented Nov 1, 2014

Current idea: Run a separate site/service that automatically rebuilds the documentation after pushing to GitHub.

The service will just be a React site that gets the API information from a JSON blob. The plan is to generate documentation for master and different versions (minor versions before 1.0). E.g. now we would only have master. When v0.3 is released, we will have master and the latest v0.3.x. tag.

I will probably create a new repo for that.
@fkling
Copy link
Owner Author

fkling commented Nov 13, 2014

I'm currently working on this. I think it only makes sense to move forward with some proper API documentation in place.

@fkling fkling added this to the v0.3: Conversion to ES6 and CSJ modules, new API milestone Nov 14, 2014
@fkling fkling mentioned this issue Mar 8, 2015
Closed
4 tasks
@fkling fkling closed this as completed Apr 11, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
v0.3: conversion to ES6 + new API
Development

No branches or pull requests
1 participant
@fkling