[DX-1100] Fix broken links, hardcoded keys, and misguided references across docs#3342
Draft
[DX-1100] Fix broken links, hardcoded keys, and misguided references across docs#3342
Conversation
… docs
Fix incorrect internal anchors (e.g. #api-key → #api-keys, #skipping → skip-integrations), convert absolute ably.com URLs to relative paths,
upgrade http:// to https:// for external links,
replace hardcoded API keys with {{API_KEY}} template variable,
add missing hyperlinks for feature references,
remove trailing dots from anchor fragments,
and fix minor copy issues including a localhost URL and stale TODO comment.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
sacOO7
changed the title
… content
Fix broken internal anchors (e.g. #presence-multiple-client-id → #multiple-client-ids,
#app-limits → #account), correct missing leading slashes in link paths,
replace hardcoded API keys with {{API_KEY}}, standardize "real-time" to
"realtime" and "Ably Realtime SDK" to "Ably Pub/Sub SDK", update past-date
deprecation pages to past tense, fix a missing code block closure in
chat data-extraction, and add cross-references for Chat moderation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
pages (wrong anchors, outdated paths, trailing dots in fragments)
ably.com/docsandably.ioURLs to relative/docs/paths and updatehttp://tohttps://for external links (ruby-doc.org)
'your-api-key'/'<YOUR_API_KEY>'strings with{{API_KEY}}template variable in codeexamples
improved meta descriptions