Skip to content

docs: mark environment variable runtime scopes - #138

Merged
NekomyaDev merged 2 commits into
NekomyaDev:mainfrom
jiangyuer018:docs/issue-133-runtime-scopes
Oct 16, 2026
Merged

NekomyaDev merged 2 commits into
NekomyaDev:mainfrom
jiangyuer018:docs/issue-133-runtime-scopes

Conversation

@jiangyuer018

Copy link
Copy Markdown
Contributor

Closes #133\n\n## Problem\nThe README environment-variable table did not say whether each variable is read by the native Rust runtime, the legacy Python/TypeScript runtimes, or both.\n\n## Change\nAdded a Scope column for every row, split mixed-scope rows where needed, and documented the scope labels.\n\n## Validation\n- git diff --check

@NekomyaDev NekomyaDev left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thank you for working on this! Several scope annotations in the Environment Variables table need corrections before merging:

  1. NUDGE_REPAIR_BUDGET: Marked as python/TS, but it is only read in the Python runtime (runtime/nudge_runtime/__init__.py:1494) and is absent from runtime/nudge_runtime.ts. This should be python.
  2. NUDGE_OTEL and NUDGE_OTEL_ENDPOINT: Marked as python/TS, but they are only implemented in Python (runtime/nudge_runtime/__init__.py:727, 749) and not in TypeScript or native Rust. These should be python.
  3. NUDGE_DECISION_SERVERS and NUDGE_DECISION_CACHE: Marked as both, but neither is supported in the native Rust runtime (crates/ has only deterministic fake decisions; live servers and caching are Python/TS only). Marking them as both is inaccurate.
  4. CI Status: pre-commit.ci is currently failing on this branch.

Please update the annotations and rebase/fix CI so we can get this landed.

@jiangyuer018

Copy link
Copy Markdown
Contributor Author

Updated the environment variable scope annotations as requested:

  • NUDGE_REPAIR_BUDGET is now python.
  • NUDGE_OTEL and NUDGE_OTEL_ENDPOINT are now python.
  • NUDGE_DECISION_SERVERS and NUDGE_DECISION_CACHE are now python/TS.

Also applied the whitespace and EOF fixes reported by pre-commit.ci. The new pre-commit.ci check is passing on commit 792dc53.

@NekomyaDev
NekomyaDev merged commit 2abb66d into NekomyaDev:main Oct 16, 2026
8 checks passed
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.

[docs] Mark which env vars are Python/TS-only vs native Rust in the README table

2 participants