docs: add details on locating proxies.xml examples and clarify conf…

[predic8]

…iguration transition from XML to YAML

Summary by CodeRabbit

• Documentation
  • Added guidance on proxy configuration options
  • Clarified continued support for XML-based proxy configuration
  • Provided reference to sample proxy configuration files

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@predic8 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 1 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 2ce76f3 and 080a1a1.

📒 Files selected for processing (1)

• distribution/examples/proxies.xml.README.md (1 hunks)

Walkthrough

A new markdown file is added to the distribution/examples directory providing guidance on proxies.xml configuration samples, clarifying that XML configuration remains supported alongside the newer YAML format, with references to external documentation.

Changes

Cohort / File(s)	Change Summary
Documentation Addition distribution/examples/proxies.xml.README.md	New markdown file added with guidance about proxies.xml samples, noting XML-to-YAML migration context, confirming XML support, and linking to sample configurations

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Rollback YAML samples in README.md #2345: Documentation update that favors XML over YAML samples in configuration examples
• conf-dir: Small Improvements apis.yaml and README.md #2363: Documentation changes addressing the XML-to-YAML configuration migration pathway
• edit doc #1986: Documentation modifications related to proxies.xml examples and guidance content

Suggested reviewers

• christiangoerdes
• rrayst

Poem

🐰 A rabbit scribbles docs with care,
"XML lives!" the message fair,
YAML too, in harmony,
Sample configs, clear to see,
README guides the seekers right,
Proxies configured, shining bright! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main changes: adding documentation details about locating proxies.xml examples and clarifying the XML to YAML configuration transition.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[predic8]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (2)

distribution/examples/proxies.xml.REAME.md (2)

3-5: Use hyphens in compound adjectives: XML-based and YAML-based

Apply this diff to correct hyphenation:

-Membrane is moving from XML based configuration to YAML based configuration. However, Membrane still 
-supports the XML based configuration with 'proxies.xml' files. Some examples in the subfolders are 
+Membrane is moving from XML-based configuration to YAML-based configuration. However, Membrane still 
+supports the XML-based configuration with 'proxies.xml' files. Some examples in the subfolders are 

---

9-9: Format bare URL as a markdown link

Apply this diff to follow markdown best practices:

-https://github.com/membrane/api-gateway/tree/master/distribution/examples
+[GitHub examples](https://github.com/membrane/api-gateway/tree/master/distribution/examples)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6293988 and 2ce76f3.

📒 Files selected for processing (1)

• distribution/examples/proxies.xml.REAME.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

distribution/examples/proxies.xml.REAME.md

[grammar] ~3-~3: Use a hyphen to join words.
Context: ...ml samples? Membrane is moving from XML based configuration to YAML based config...

(QB_NEW_EN_HYPHEN)

---

[grammar] ~3-~3: Use a hyphen to join words.
Context: ...ing from XML based configuration to YAML based configuration. However, Membrane s...

(QB_NEW_EN_HYPHEN)

---

[grammar] ~4-~4: Use a hyphen to join words.
Context: ...owever, Membrane still supports the XML based configuration with 'proxies.xml' f...

(QB_NEW_EN_HYPHEN)

🪛 markdownlint-cli2 (0.18.1)

distribution/examples/proxies.xml.REAME.md

9-9: Bare URL used

(MD034, no-bare-urls)