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

github.webhook is missing field-level descriptions #1102

Closed
starpit opened this issue Aug 21, 2016 · 1 comment
Closed

github.webhook is missing field-level descriptions #1102

starpit opened this issue Aug 21, 2016 · 1 comment
Assignees
Labels

Comments

@starpit
Copy link
Contributor

starpit commented Aug 21, 2016

in addition to adding some simple but helpful field-level descriptions. i suggest that we pioneer here a doclink field. this will be particularly helpful for the accessToken and events fields, which are quite cryptic on their own.

also, the main description field inaccurately renders GitHub as "github".

@starpit starpit self-assigned this Aug 21, 2016
@starpit
Copy link
Contributor Author

starpit commented Aug 21, 2016

here is a suggestion of how it might look, where the `doclink`` fields are rendered as Learn More anchors.

github webhook description update

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants