docs: improve server replace guide#2770
Merged
Merged
Conversation
|
kanoru3101
changed the title
Contributor
|
Contributor
Coverage Report
File CoverageNo changed files found. |
kanoru3101
commented
Apr 23, 2026
|
|
||
| - [Install @redocly/cli](../installation.md) with version 1.0.0-beta.111 or later (we use 1.0.0-beta.111 in this tutorial). | ||
| - Save the following OpenAPI file as `original.yaml` into a new directory named `replace-servers-demo`. | ||
| ```yaml |
Contributor
Author
There was a problem hiding this comment.
The duplicate example has been removed. The same example is provided in the next section.
tatomyr
reviewed
Apr 23, 2026
JLekawa
approved these changes
Apr 24, 2026
tatomyr
approved these changes
Apr 24, 2026
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
3 participants
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.
What/Why/How?
Improved server replace guide.
Reference
Close #1518
Testing
Screenshots (optional)
Check yourself
Security
Note
Low Risk
Documentation-only updates that clarify setup and configuration; no runtime code changes or behavioral impact.
Overview
Updates the
replace-servers-urlguide to align with Redocly CLI 2.x and streamline the tutorial flow.Clarifies the plugin/decorator responsibilities, updates prerequisites and wording, and adjusts the configuration example to show one API entry per environment passing different
serverUrlvalues, plus minor command phrasing and admonition guidance.Reviewed by Cursor Bugbot for commit bd505fd. Bugbot is set up for automated code reviews on this repo. Configure here.