crowdin-api-client-ruby icon indicating copy to clipboard operation
crowdin-api-client-ruby copied to clipboard

Auto generated docs

Open andrii-bodnar opened this issue 3 years ago • 0 comments

As a Crowdin Ruby API client user, I would like to have online docs to navigate and explore the client resources, methods, parameters, etc.

Examples:

These docs should be generated using GH Actions and deployed to GH Pages. Workflow example: docs.yml

The possible tool for that is rdoc.

Steps:

  • [ ] Explore tools to generate docs from code, and choose the best one.
  • [ ] Create a config and provide a command to generate the docs.
  • [ ] If needed, add additional annotations to the API Client code (ignore some unneeded methods in docs, add some method or parameter descriptions, etc).
  • [ ] Set up the GH workflow. @andrii-bodnar can help with that.
  • [ ] Set up the GH pages feature for the repo. @andrii-bodnar

andrii-bodnar avatar Sep 21 '22 11:09 andrii-bodnar