Skip to content

Conversation

yurisasuke
Copy link
Member

@yurisasuke yurisasuke commented Jul 14, 2025

PR Type

Enhancement, Documentation


Description

  • Added global navigation anchors for support and community

  • Introduced Redis version compatibility snippet

  • Improved footer and navigation structure in docs config

  • Fixed and clarified documentation typos and links


Changes diagram

flowchart LR
  A["Add global anchors to navigation"] -- "docs.json" --> B["docs navigation config"]
  B -- "footer/socials/links refactored" --> C["footer structure improved"]
  B -- "Redis version snippet added" --> D["snippets/RedisVersions.mdx"]
  E["Documentation typo/link fixes"] --> F["Various .mdx files"]
Loading

Changes walkthrough 📝

Relevant files
Enhancement
1 files
docs.json
Add global navigation anchors and refactor footer/navigation
+95/-89 
Documentation
6 files
RedisVersions.mdx
Add Redis version compatibility snippet                                   
+4/-0     
api-to-mcp.mdx
Update diagrams, links, and minor text fixes                         
+11/-8   
gateway-config-managing-oas.mdx
Fix repeated typo and clarify update instructions               
+4/-4     
multiple-auth.mdx
Correct explanation of security scheme handling                   
+1/-1     
overview.mdx
Fix release notes path for Tyk Sync                                           
+1/-1     
plan-your-api-integration.mdx
Fix developer portal documentation link                                   
+1/-1     
Formatting
1 files
tyk-self-managed.mdx
Remove trailing blank line                                                             
+0/-1     

Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Navigation Consistency

    The addition of global navigation anchors for "Enterprise Support" and "Tyk Community" in the navigation config should be validated to ensure they are rendered correctly and do not conflict or duplicate with existing navbar links. Check that the icons and URLs are correct and that the new structure works as intended across all supported devices and themes.

    "global": {
      "anchors": [
        {
          "anchor": "Enterprise Support",
          "icon": "/img/support_icon.png",
          "href": "https://support.tyk.io/"
        },
        {
          "anchor": "Tyk Community",
          "icon": "/img/community_icon.png",
          "href": "https://tyk.io/community/"
        }
      ]
    },
    Documentation Accuracy

    The new Redis version compatibility snippet should be reviewed for technical accuracy and clarity, ensuring that the stated version support matches actual product compatibility and does not mislead users.

    ### Supported Versions
    
    - Tyk 5.3 supports Redis 6.2.x, 7.0.x, and 7.2.x
    - Tyk 5.2.x and earlier supports Redis 6.0.x and Redis 6.2.x only.

    Copy link

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @yurisasuke yurisasuke merged commit b0490bc into main Jul 14, 2025
    7 checks passed
    @buger
    Copy link
    Member

    buger commented Jul 14, 2025

    /release to release-5.8

    @buger
    Copy link
    Member

    buger commented Jul 14, 2025

    /release to release-5.7

    @buger
    Copy link
    Member

    buger commented Jul 14, 2025

    /release to release-5.6

    Copy link

    ℹ️ Cherry-pick skipped: no changes needed in target branch.

    buger pushed a commit that referenced this pull request Jul 14, 2025
    * add navigation global
    
    * add images
    
    ---------
    
    Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
    (cherry picked from commit b0490bc)
    Copy link

    ✅ Cherry-pick successful. A PR was created and auto-merged (if allowed): #626

    Copy link

    ℹ️ Cherry-pick skipped: no changes needed in target branch.

    buger added a commit that referenced this pull request Jul 14, 2025
    add navigation global (#624)
    
    * add navigation global
    
    * add images
    
    ---------
    
    Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>
    @yurisasuke
    Copy link
    Member Author

    /release to release-5.7

    Copy link

    ℹ️ Cherry-pick skipped: no changes needed in target branch.

    @yurisasuke
    Copy link
    Member Author

    /release to release-5.6

    Copy link

    ℹ️ Cherry-pick skipped: no changes needed in target branch.

    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