[DOCS]: Fix / update generation for the docs for Octokit.rb - Githubissues

octokit / octokit.rb

Ruby toolkit for the GitHub API

http://octokit.github.io/octokit.rb/

MIT License

3.83k stars 1.13k forks source link

[DOCS]: Fix / update generation for the docs for Octokit.rb #1700

Open nickfloyd opened 3 weeks ago

nickfloyd commented 3 weeks ago

Describe the need

Currently, as one of our contributors has pointed out, the docs located at: https://octokit.github.io/octokit.rb/ are about 5 years out of date.

We need to renew our docs by:

[ ] Creating a way that the docs can be regenerated (we used yard in the past) each time a merge to master occurs
[ ] The need to be hosted in a public location
[ ] The approach should respect separation of concerns so that it can be properly tested, validated, and used as part of the dev cycle if needed.

SDK Version

No response

API Version

No response

Relevant log output

No response

Code of Conduct

[x] I agree to follow this project's Code of Conduct

github-actions[bot] commented 3 weeks ago

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀