Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

validate anchor links failure #5720

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

validate anchor links failure #5720

wants to merge 7 commits into from

Conversation

yurisasuke
Copy link
Member

@yurisasuke yurisasuke commented Nov 15, 2024

PR Type

documentation


Description

  • Updated the anchor link in the 'Get Started' section of the documentation to ensure it points to the correct section for installation.
  • This change is intended to validate the anchor link functionality and improve navigation within the documentation.

Changes walkthrough 📝

Relevant files
Documentation
open-source.md
Update anchor link for installation reference                       

tyk-docs/content/apim/open-source.md

  • Updated the anchor link in the 'Get Started' section.
  • Changed the reference to include a specific anchor for validation.
  • +1/-1     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    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
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Ensure anchor links in markdown files are valid to prevent broken links

    Ensure that the anchor link in the markdown file is valid and points to an existing
    section or tag to avoid broken links in the documentation.

    tyk-docs/content/apim/open-source.md [33]

    -To Get started, simply install [Tyk Open Source]({{< ref "apim/open-source/installation#test-anchor-validation" >}}), and then create your first API!
    +To Get started, simply install [Tyk Open Source]({{< ref "apim/open-source/installation#correct-anchor" >}}), and then create your first API!
    Suggestion importance[1-10]: 7

    Why: The suggestion is relevant as it addresses a potential issue with the anchor link in the markdown file, which could lead to broken links in the documentation. Ensuring the validity of the anchor link is crucial for user navigation and the integrity of the documentation.

    7

    Copy link

    netlify bot commented Nov 15, 2024

    PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit 68b5d24
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/673732c1642ec700089dfd19
    😎 Deploy Preview https://deploy-preview-5720--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 site configuration.

    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.

    1 participant