diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index a0e80f2f47..94c8b3be37 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -393,7 +393,7 @@ Some best practices for using links: - Links should be meaningful and provide high value to the user’s journey—link out carefully. - Move links that are helpful but not necessary to an article’s further reading section. - Do not repeat the same link more than once in the same article or under the same H2 header. -- Do not include the `apiVersion` query parameter in REST links unless you need to link to a specific calendar version of the REST docs. (This should be a rare occurance.) +- Do not include the `apiVersion` query parameter in REST links unless you need to link to a specific calendar version of the REST docs. (This should be a rare occurrence.) For accessibility and readability, avoid inline or midsentence links. - **Use:** `OAuth2 tokens can be acquired programmatically for applications that are not websites. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)" and "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps)."` diff --git a/contributing/troubleshooting.md b/contributing/troubleshooting.md index 1d69645b02..0f810845b6 100644 --- a/contributing/troubleshooting.md +++ b/contributing/troubleshooting.md @@ -1,6 +1,6 @@ # Troubleshooting -- [Troubleshooting server tests that fail locally but pass in CI](#troublshooting-server-tests-that-fail-locally-but-pass-in-ci) +- [Troubleshooting server tests that fail locally but pass in CI](#troubleshooting-server-tests-that-fail-locally-but-pass-in-ci) - [Troubleshooting stalled deployments and CI](#troubleshooting-stalled-deployments-and-ci) - [Staging deployment stalled](#staging-deployment-stalled) - [CI stalled or stuck](#ci-stalled-or-stuck)