[DOCS] Inconsistent Versioning for "Latest" in autoUpdatesChannel documentation
Documentation Type
Unclear/confusing documentation
Documentation Location
Section/Topic
The autoUpdatesChannel setting description and examples in both the Settings and Setup sections.
Current Documentation
In docs/en/settings inside the "Available settings" table:
Description: "Release channel to follow for updates. Use 'stable' for a version that is typically about one week old and skips versions with major regressions, or 'latest' (default) for the most recent release" Example: "stable"
In docs/en/setup under "Configure release channel":
*"latest"(default): Receive new features as soon as they're released ``json { "autoUpdatesChannel": "stable" }``
What's Wrong or Missing?
The documentation consistently identifies "latest" as the default behavior, yet provides "stable" as the example value in both the settings table and the setup configuration block. While not technically an error (as examples often illustrate how to change defaults), presenting the non-default option as the primary example across multiple pages creates an inconsistent presentation regarding the standard configuration.
Suggested Improvement
Ensure consistency in describing the default behavior. If "latest" is the default, consider using it as the example to reinforce the standard setup, or explicitly note that the example demonstrates how to opt-out of the default channel.
Impact
High - Prevents users from using a feature
Additional Context
- Location:
docs/en/settings.mdrow forautoUpdatesChannel - Location:
docs/en/setup.mdconfiguration JSON block under "Configure release channel"
This issue has 3 comments on GitHub. Read the full discussion on GitHub ↗