-
Notifications
You must be signed in to change notification settings - Fork 60.6k
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
Issue event types documentation lacks details for several event types that can be found in the API #35406
Comments
@Fs00 Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛 |
Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀 |
This is a gentle bump for the docs team that this issue is waiting for technical review. |
@Fs00 Thank you so much for your patience while our SME team reviewed! ✨ After some digging, we found that issue-event-types.md has actually been written manually! Given this doc is not auto-generated, and we currently don't have plans to auto-generate this content in the near future, we'd love to open up filling in the missing event types to the community 💛 We've added the |
Thanks for the answer @nguyenalex836, even if it's a bit disappointing IMHO. Can we have at least a glimpse on why there are no plans to auto-generate the article content? If it's going to be updated only manually, it'll always lag behind the actual event types returned by the API (which will eventually add up as new features are added to GitHub). |
@Fs00 We completely understand. Whilst autogeneration certainly be helpful, implementation would be complex and require company-wide investment. We will certainly keep this idea on our radar for future GitHub Docs enhancements 💛 |
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/developers/webhooks-and-events/events/issue-event-types
What part(s) of the article would you like to see updated?
There are several issue event types that can be encountered when using the issue/timeline events REST API that are not documented in the aforementioned page. Some examples are
added_to_merge_queue
,auto_merge_disabled
,auto_merge_enabled
,auto_squash_enabled
, but there are others...As @felicitymay rightly pointed out in #35045, auto-generating the content of the article would be the best way to ensure it stays up-to-date as new events are introduced.
Additional information
No response
The text was updated successfully, but these errors were encountered: