Skip to content

fix variable format in docs#3872

Merged
ethanpalm merged 1 commit intomainfrom
lindsay/update-variables
Feb 27, 2026
Merged

fix variable format in docs#3872
ethanpalm merged 1 commit intomainfrom
lindsay/update-variables

Conversation

@lindsayzhng
Copy link
Contributor

@lindsayzhng lindsayzhng commented Feb 27, 2026

Documentation changes

Fix variable format to be a drop down and have example in examples section


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Low risk documentation-only change that updates the docs.json reference and examples; no runtime code or behavior is modified.

Overview
Updates organize/settings.mdx to reformat the variables setting documentation into an Expandable reference entry and clarifies that all referenced variables must be defined (build fails otherwise).

Adds variables blocks (e.g., version, api-url) to the docs.json examples so the documented syntax is demonstrated in the examples section.

Written by Cursor Bugbot for commit 06988ca. This will update automatically on new commits. Configure here.

Copy link
Collaborator

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

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

lgtm!

@ethanpalm ethanpalm merged commit 2209c4b into main Feb 27, 2026
3 checks passed
@ethanpalm ethanpalm deleted the lindsay/update-variables branch February 27, 2026 22:39
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.

2 participants