[REQUIREMENT][Ruby] Source code documentation for every release build that is published.
Open
Nobody has claimed this yet.
area/ruby-client
kind/feature
priority/medium
- Dominant language
- Java
- Stars
- 72
- Forks
- 69
- Avg merge
- 23h 32m
- Merged PRs (30d)
- 4
Description
Is your feature request related to a problem? Please describe.
Source code documentation in https://vmware.github.io/singleton/docs/overview/singleton-sdk/ for every release build that is published.
Describe the solution you'd like
- Run
rdoc -include ./lib/ README.mdunder root directory. This will generate/update adocdirectory in root. Thedocdirectory will contain auto-generated html files from source code. - See sample index.html generated in my local machine:
- Have the
docdirectory published under the resources folder, and the README.md published under the singleton-sdk folder in the website branch.
Describe alternatives you've considered
https://ruby.libhunt.com/rdoc-alternatives
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.