Escape the brackets in the text link

[letzya]

User description

Contributor checklist

• Reviewed PR Code suggestions and updated accordingly
• Tyklings: Labled the PR with the relevant releases
• Tyklings: Added Jira DX PR ticket to the subject

---

New Contributors

• Start the PR branch from our latest master
• I have read the repository contribution guidelines
• I have read the repository technical guidelines

---

---

PR Type

Documentation

---

Description

• Escaped curly brackets in Markdown link text for clarity

• Improved documentation formatting for parameter references

• No functional or code logic changes

• Enhances readability in developer documentation

---

Changes diagram

flowchart LR
  A["Documentation with unescaped brackets"] -- "Escape brackets" --> B["Documentation with escaped brackets"]

Loading

---

Changes walkthrough 📝

	Relevant files
Documentation	inclusive-naming-policy.md Escape curly brackets in Markdown link text                            tyk-docs/content/developer-support/inclusive-naming-policy.md Escaped curly brackets in Markdown link text for parameter references Improved clarity and formatting in documentation +2/-2

---

Need help?

Type /help how to ... in the comments thread for any questions about PR-Agent usage.

Check out the documentation for more information.

[github-actions]

⚠️ Deploy preview for PR #6726 did not become live after 3 attempts.
Please check Netlify or try manually: Preview URL

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No major issues detected

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.

[github-actions]

PR Analysis: Escaping Curly Brackets in Markdown Link Text

This PR makes a small but important documentation improvement by escaping curly brackets in Markdown link text for parameter references in the inclusive-naming-policy.md file.

Changes Made

The PR modifies two lines in the file by adding backslash escapes (\) before curly brackets in Markdown link text:

Before:

- [version_data.versions.{version-name}.extended_paths.black_list]({{< ref "api-management/traffic-transformation/block-list#api-definition" >}})
- [version_data.versions.{version-name}.extended_paths.white_list]({{< ref "api-management/traffic-transformation/allow-list#api-definition" >}})

After:

- [version_data.versions.\{version-name\}.extended_paths.black_list]({{< ref "api-management/traffic-transformation/block-list#api-definition" >}})
- [version_data.versions.\{version-name\}.extended_paths.white_list]({{< ref "api-management/traffic-transformation/allow-list#api-definition" >}})

Impact and Benefits

1. Improved Readability: Escaping the curly brackets makes it clearer that these are literal characters in parameter names rather than Markdown or template syntax.

2. Prevents Rendering Issues: Unescaped curly brackets in Markdown can sometimes be misinterpreted by rendering engines, potentially causing display problems.

3. Better Documentation Practices: This change follows best practices for technical documentation by properly escaping special characters.

This is a straightforward documentation improvement with no functional changes to code or logic. The change enhances the clarity of parameter references in the inclusive naming policy documentation.

---

Tip: Mention me again using /probe <request>.
Powered by Probe AI

[netlify]

✅ PS. Add to the end of url /docs/nightly

Name	Link
🔨 Latest commit	1bc0aa3
🔍 Latest deploy log	https://app.netlify.com/projects/tyk-docs/deploys/687542e4cfe6f30008e942e8
😎 Deploy Preview	https://deploy-preview-6726--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[sharadregoti]

/release to release-5.8

[letzya]

fixing so mintlify won't break @yurisasuke

[tykbot]

Working on it! Note that it can take a few minutes.

[tykbot]

@sharadregoti Created merge PRs