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

Docs #16

Closed
6 tasks done
matteofigus opened this issue Feb 3, 2015 · 3 comments
Closed
6 tasks done

Docs #16

matteofigus opened this issue Feb 3, 2015 · 3 comments

Comments

@matteofigus
Copy link
Member

We should start writing the docs.

  • Getting started (component init, dev) with examples
  • Registry advanced configurations
  • server.js advanced development and api
  • node.js library - usage and api
  • client-side library - usage and api
  • cli - commands
@matteofigus
Copy link
Member Author

As agreed, @jankowiakmaria, we can generate the cli commands one automatically hooking the grunt build task.

@matteofigus
Copy link
Member Author

@federicomaffei it would be good if you could work on the cli automatic documentation. The idea is to generate the cli.md file on the docs dir automatically from the ./cli/commands.js file when the grunt build task is launched so that we have up-to-date cli doc.

In addition to the list of commands and parameters, we also need to include the bit needed to setup autocompletion (currently on the cli.md).

@matteofigus
Copy link
Member Author

This is the last piece: https://github.com/opentable/oc/tree/master/client

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

No branches or pull requests

2 participants