[DOCS]: Required status checks for branch protection

[regexj-twinkl]

Describe the need

The documentation around formatting on required status checks for branch protection is confusing. There is a link to github documentation ("See GitHub Documentation for more information") which is actually just a link to the same terraform documentation page.

Would be handy to either have some clear examples on this page or a reference to github that goes to a documentation and/or example page on github (I don't know if anything exists at github though as I'm struggling to find such a page).

https://registry.terraform.io/providers/integrations/github/latest/docs/resources/branch_protection#required-status-checks

SDK Version

No response

API Version

No response

Relevant log output

Code of Conduct

• I agree to follow this project's Code of Conduct

[stevehipwell]

@regexj-twinkl we can take a look at improving the docs, but have you looked at switching over to a ruleset? Branch protection isn't deprecated (yet) but is referred to as legacy in the docs and UI.

[ViacheslavKudinov]

Hi @regexj-twinkl
would something like this doc (and more examples down) be helpful for "branch protection" resource ?

I can create PR to get it on real GItHub provider.

PS This provider i posted link to is just my development version of GitHub provider. Do not use one!