Skip to content

[📃 Docs]: Broken Markdown link (reversed brackets/parentheses) in docs #5400

@gecube

Description

@gecube

Summary

A Slack community link in the documentation is formatted with misordered Markdown syntax, causing the link to render as plain text instead of a hyperlink.

The correct Markdown format is [text](url), but the docs contain (text)[url] in at least one place.

Reference PR (closed): docs: Fix Slack community link formatting in documentation — demonstrates the issue and proposed fix.
See: #5388


Affected location(s)

File: docs/deployment/local-llm/keep-with-litellm.mdx

Diff context (PR #5388):

- If you encounter any issues, please talk to us at our (Slack
- community)[https://slack.keephq.dev].
+ If you encounter any issues, please talk to us at our [Slack community](https://slack.keephq.dev).

Steps to reproduce

  1. Open the page Running Keep with LiteLLM in the docs.
  2. Locate the paragraph with the Slack community reference.
  3. Observe that the link does not render as a clickable hyperlink if the broken format is present.

Expected behavior

  • Links should render correctly using [Slack community](https://slack.keephq.dev) syntax.

Actual behavior

  • The text shows up as plain text with parentheses/brackets in the wrong order, and the link is not clickable.

Suggested fix

  1. Fix all occurrences of misordered Markdown: change (Text)[URL][Text](URL).
  2. Add a CI check for Markdown links to prevent regressions (e.g. markdown-link-check GitHub Action) to detect broken links and malformed syntax.
  3. Optionally run a one-time grep to discover similar patterns across the docs:
git grep -nE '\([^\)]*\)\[[^\]]*\]' -- docs/ | sed 's/^/Suspicious link syntax: /'

Notes

  • This issue was highlighted in PR docs: Fix Slack community link formatting in documentation #5388 and subsequently closed with the comment that it “renders fine”, but the diff shows a clear syntax error in standard Markdown and MDX.
  • Consider re-opening or tracking via this issue so the fix can be applied consistently across documentation.

Labels: type:bug area:documentation priority:low

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions