docs: fix broken callbacks anchor in FAQ - #111
Merged
Merged
Conversation
Two links in the FAQ pointed at client-usage.md#callbacks. There is no "Callbacks" heading in that file — the sections are "Lifecycle callbacks" (the options reference) and "Lifecycle callbacks (in detail)". Both links now target the detail section, which is what the surrounding prose is describing: the functions and objects each callback hands you. The anchor is broken on GitHub and in developers.tpastream.com, which renders these docs via clone-sdk-docs.sh and flags it as a broken anchor on every build. Sync of LakeEriePartners#13; docs/faq.md is byte-identical to that repo's master after this change.
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.
Sync of LakeEriePartners#13, which is already merged there.
Two links in
docs/faq.mdpointed atclient-usage.md#callbacks. There's no "Callbacks" heading in that file — the sections areLifecycle callbacks(the options reference) andLifecycle callbacks (in detail). Both now target the detail section, which is what the surrounding prose is talking about: the functions and objects each callback hands you.The anchor is broken both on GitHub and on developers.tpastream.com, which renders these docs by cloning this repo at build time (
scripts/clone-sdk-docs.sh,SDK_REPOdefaults toTPAStream/stream-connect-js-sdk). That's why the fix needs to land here and not only on the LakeEriePartners side — the merged PR there doesn't reach the published docs on its own.Verification
## Lifecycle callbacks (in detail)exists atdocs/client-usage.md:209on this branch, andclient-usage.mdis identical between the two repos, so the target resolves.docs/faq.mdis byte-identical to LakeEriePartners master.Docs-only; no source or bundle changes.