Skip to content

docs: align BrightScript SDK documentation - #992

Merged
jonathannorris merged 2 commits into
mainfrom
docs-sdk-brightscript
Aug 7, 2026
Merged

docs: align BrightScript SDK documentation#992
jonathannorris merged 2 commits into
mainfrom
docs-sdk-brightscript

Conversation

@jonathannorris

@jonathannorris jonathannorris commented Aug 6, 2026

Copy link
Copy Markdown
Member

Summary

  • Correct the Roku source link.
  • Document the actual pre-initialization return behavior for feature and variable collections.

Validation

  • git diff --check passed

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 6, 2026

Copy link
Copy Markdown

Deploying devcycle-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

@jonathannorris
jonathannorris force-pushed the docs-sdk-brightscript branch from 28ef85e to 0857c8c Compare August 6, 2026 18:12
@jonathannorris
jonathannorris marked this pull request as ready for review August 6, 2026 18:12
Copilot AI review requested due to automatic review settings August 6, 2026 18:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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() return invalid (and log an error) when called before initialization completes.
  • Fix the “DevCycle Options” source link to point to the correct DevCycleHQ/roku-client-sdk repository.

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.

Comment thread docs/sdk/client-side-sdks/roku/roku-usage.md Outdated
@jonathannorris
jonathannorris force-pushed the docs-sdk-brightscript branch from 8ad74c3 to 2790fd5 Compare August 7, 2026 16:03
@jonathannorris
jonathannorris merged commit 8de7c16 into main Aug 7, 2026
5 checks passed
@jonathannorris
jonathannorris deleted the docs-sdk-brightscript branch August 7, 2026 16:16
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.

3 participants