Skip to content

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

Open
lukegalbraithrussell wants to merge 2 commits into
mainfrom
docs-audit
Open

docs: audit and fix docs/english markdown files#1883
lukegalbraithrussell wants to merge 2 commits into
mainfrom
docs-audit

Conversation

@lukegalbraithrussell
Copy link
Copy Markdown
Contributor

@lukegalbraithrussell lukegalbraithrussell commented May 29, 2026

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.

Category Description
Docusaurus 3.10 migration Converted all 114 {#id} heading anchors to {/* #id */} JSX comment syntax
Incorrect class/method references Fixed AsyncWebhookClientAsyncWebClient, prepare_for_next_retryprepare_for_next_attempt, slack_sdk.http_retry RetryHandlerslack_sdk.http_retry.RetryHandler
Copy-paste errors Fixed audit-logs.md referencing "SCIM API" / "AsyncSCIMClient" instead of Audit Logs equivalents
Incorrect module paths Fixed slack.rtm_v2.RTMClientslack_sdk.rtm_v2.RTMClient in rtm.md
Wrong variable names Fixed client.retry_handlerswebhook.retry_handlers in webhook.md
Incorrect API references Fixed filter param value in scim.md (removed redundant filter= prefix)
Broken URL Fixed https://tools slack.dev/...https://docs.slack.dev/tools/... in v3-migration.md
Code example inconsistency Fixed mismatched callback_id and removed duplicate paragraph in web.md
Undefined variables Fixed client_id / redirect_uri references in oauth.md callback example
Spelling and grammar Fixed 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 owners May 29, 2026 16:15
@codecov
Copy link
Copy Markdown

codecov Bot commented May 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.12%. Comparing base (078ba76) to head (c2217d4).
⚠️ 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.13%   84.12%   -0.02%     
==========================================
  Files         117      117              
  Lines       13337    13340       +3     
==========================================
+ Hits        11221    11222       +1     
- Misses       2116     2118       +2     

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

Sign up for free to 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.

1 participant