Skip to content

Conversation

andyo-tyk
Copy link
Contributor

@andyo-tyk andyo-tyk commented Sep 16, 2025

User description

Minor formatting issue in 5.3.12 dependencies section

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



PR Type

Documentation


Description

  • Add blank line after dependencies table

Diagram Walkthrough

flowchart LR
  depsTable["Dependencies table (5.3.12)"] -- "add spacing" --> noteBlock["Advisory paragraph renders properly"]
Loading

File Walkthrough

Relevant files
Documentation
gateway.md
Add spacing after dependencies table                                         

tyk-docs/content/developer-support/release-notes/gateway.md

  • Insert a blank line after the dependencies table
  • Preserve surrounding content and links
+1/-0     

Minor formatting issue in 5.3.12 dependencies section
Copy link
Contributor

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

Copy link
Contributor

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
⚡ Recommended focus areas for review

Formatting Consistency

Ensure the added blank line doesn't break the Markdown table rendering in the static site generator (Hugo) and is consistent with spacing used after other tables in the document.

Given the potential time difference between your upgrade and the release of this version, we recommend users verify the ongoing support of third-party dependencies they install, as their status may have changed since the release.

Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Remove unintended blank line

Remove the stray blank line inserted between the table and the following paragraph
to avoid unintended spacing or broken table rendering in Markdown/Hugo. Keeping the
paragraph directly after the table maintains consistent formatting.

tyk-docs/content/developer-support/release-notes/gateway.md [2717]

-+
+Given the potential time difference between your upgrade and the release of this version, we recommend users verify the ongoing support of third-party dependencies they install, as their status may have changed since the release.
Suggestion importance[1-10]: 6

__

Why: The suggestion correctly identifies a newly added blank line (+) at line 2717 that can cause unwanted spacing in Markdown tables; removing it is a minor but valid formatting fix. The improved_code reflects the paragraph directly following the table without the blank line.

Low

Copy link

netlify bot commented Sep 16, 2025

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

Name Link
🔨 Latest commit 6b2fe9c
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68c924aeaf09e800082d2444
😎 Deploy Preview https://deploy-preview-6934--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

1 similar comment
Copy link

netlify bot commented Sep 16, 2025

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

Name Link
🔨 Latest commit 6b2fe9c
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68c924aeaf09e800082d2444
😎 Deploy Preview https://deploy-preview-6934--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

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 sharadregoti merged commit da2370d into master Sep 16, 2025
13 of 14 checks passed
@sharadregoti sharadregoti deleted the RN-formatting-fix branch September 16, 2025 12:14
@sharadregoti
Copy link
Contributor

/release to release-5.8

@sharadregoti
Copy link
Contributor

/release to release-5.3

@sharadregoti
Copy link
Contributor

/release to release-5.9

Copy link
Contributor

tykbot bot commented Sep 16, 2025

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

2 similar comments
Copy link
Contributor

tykbot bot commented Sep 16, 2025

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

Copy link
Contributor

tykbot bot commented Sep 16, 2025

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

tykbot bot pushed a commit that referenced this pull request Sep 16, 2025
(cherry picked from commit da2370d)
Copy link
Contributor

tykbot bot commented Sep 16, 2025

@sharadregoti Created merge PRs

Copy link
Contributor

tykbot bot commented Sep 16, 2025

Still working...

1 similar comment
Copy link
Contributor

tykbot bot commented Sep 16, 2025

Still working...

tykbot bot pushed a commit that referenced this pull request Sep 16, 2025
(cherry picked from commit da2370d)
Copy link
Contributor

tykbot bot commented Sep 16, 2025

@sharadregoti Created merge PRs

tykbot bot pushed a commit that referenced this pull request Sep 16, 2025
(cherry picked from commit da2370d)
Copy link
Contributor

tykbot bot commented Sep 16, 2025

@sharadregoti Created merge PRs

buger added a commit that referenced this pull request Sep 16, 2025
buger added a commit that referenced this pull request Sep 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants