Skip to content

docs: audit and fix docs/english markdown files - #1883

Merged
lukegalbraithrussell merged 4 commits into
mainfrom
docs-audit
Jun 4, 2026
Merged

docs: audit and fix docs/english markdown files#1883
lukegalbraithrussell merged 4 commits into
mainfrom
docs-audit

Conversation

@lukegalbraithrussell

@lukegalbraithrusselllukegalbraithrussell commented May 29, 2026

Copy link
Copy Markdown
Contributor

Summary

Audited all docs/english/ markdown files against source code for accuracy, fixed inaccuracies, corrected spelling/grammar, and migrated heading ID syntax for Docusaurus 3.10 compatibility.

CategoryDescription
Docusaurus 3.10 migrationConverted all 114 {#id} heading anchors to {/* #id */} JSX comment syntax
Incorrect class/method referencesFixed AsyncWebhookClientAsyncWebClient, prepare_for_next_retryprepare_for_next_attempt, slack_sdk.http_retry RetryHandlerslack_sdk.http_retry.RetryHandler
Copy-paste errorsFixed audit-logs.md referencing "SCIM API" / "AsyncSCIMClient" instead of Audit Logs equivalents
Incorrect module pathsFixed slack.rtm_v2.RTMClientslack_sdk.rtm_v2.RTMClient in rtm.md
Wrong variable namesFixed client.retry_handlerswebhook.retry_handlers in webhook.md
Incorrect API referencesFixed filter param value in scim.md (removed redundant filter= prefix)
Broken URLFixed https://tools slack.dev/...https://docs.slack.dev/tools/... in v3-migration.md
Code example inconsistencyFixed mismatched callback_id and removed duplicate paragraph in web.md
Undefined variablesFixed client_id / redirect_uri references in oauth.md callback example
Spelling and grammarFixed typos ("pockage", "Adaptor", "straight-forward"), grammar ("supports" as noun, subject-verb agreement, missing articles/prepositions, "its" vs "it's"), and word errors ("methods in those methods" → "modules")

🤖 Generated with Claude Code

Co-Authored-By: Claude svc-devxp-claude@slack-corp.com

@lukegalbraithrussell
lukegalbraithrussell requested review from a team as code ownersMay 29, 2026 16:15
@codecov

codecovBot commented May 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.11%. Comparing base (2491a2d) to head (8ef0b13).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@ Coverage Diff @@## main #1883 +/- ##
==========================================
- Coverage 84.14% 84.11% -0.03% 
==========================================
Files 117 117 Lines 13356 13356 ==========================================
- Hits 11238 11234 -4 - Misses 2118 2122 +4 

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@lukegalbraithrussell
lukegalbraithrussell enabled auto-merge (squash) June 4, 2026 16:37
@lukegalbraithrussell
lukegalbraithrussell merged commit d3058ca into mainJun 4, 2026
18 checks passed
@lukegalbraithrussell
lukegalbraithrussell deleted the docs-audit branch June 4, 2026 16:44
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lukegalbraithrussell@WilliamBergamin