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]: Fix / update generation for the docs for Octokit.rb #1700

Open
1 of 4 tasks
nickfloyd opened this issue Jun 10, 2024 · 1 comment
Open
1 of 4 tasks

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

nickfloyd opened this issue Jun 10, 2024 · 1 comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation

Comments

@nickfloyd
Copy link
Contributor

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

  • I agree to follow this project's Code of Conduct
@nickfloyd nickfloyd added Status: Triage This is being looked at and prioritized Type: Documentation Improvements or additions to documentation labels Jun 10, 2024
Copy link

👋 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! 🚀

@nickfloyd nickfloyd added Status: Up for grabs Issues that are ready to be worked on by anyone and removed Status: Triage This is being looked at and prioritized labels Jun 10, 2024
@nickfloyd nickfloyd reopened this Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Documentation Improvements or additions to documentation
Projects
Status: 🔥 Backlog
Development

No branches or pull requests

1 participant