docs: align BrightScript SDK documentation - #992
Merged
Conversation
Deploying devcycle-docs with
|
| Latest commit: |
2790fd5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://98e26dd1.devcycle-docs.pages.dev |
| Branch Preview URL: | https://docs-sdk-brightscript.devcycle-docs.pages.dev |
jonathannorris
force-pushed
the
docs-sdk-brightscript
branch
from
August 6, 2026 18:12
28ef85e to
0857c8c
Compare
jonathannorris
marked this pull request as ready for review
August 6, 2026 18:12
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Roku (BrightScript) SDK docs to better reflect the current SDK behavior and correct a source link, keeping the documentation aligned with the implementation and repository location.
Changes:
- Document that
getAllFeatures()/getAllVariables()returninvalid(and log an error) when called before initialization completes. - Fix the “DevCycle Options” source link to point to the correct
DevCycleHQ/roku-client-sdkrepository.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/sdk/client-side-sdks/roku/roku-usage.md | Updates pre-initialization behavior notes for feature/variable collection methods. |
| docs/sdk/client-side-sdks/roku/roku-gettingstarted.md | Corrects the DevCycle Options link to the correct repository. |
Suppressed comments (1)
docs/sdk/client-side-sdks/roku/roku-usage.md:48
- “DevCycle task” isn’t defined elsewhere in the Roku docs and is inconsistent with the established term “DevCycleTask node” used in installation/getting-started. Use the component name here to avoid ambiguity for readers.
If the SDK has not finished initializing, these methods log an error and return `invalid`. Wait until the DevCycle task has initialized before calling them.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
JamieSinn
approved these changes
Aug 6, 2026
jonathannorris
force-pushed
the
docs-sdk-brightscript
branch
from
August 7, 2026 16:03
8ad74c3 to
2790fd5
Compare
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
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.
Summary
Validation