Skip to content

markdownlint: Ignore flags bare URLs (MD034) on the :link: lines #206

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

Open
amotl opened this issue May 19, 2025 · 0 comments
Open

markdownlint: Ignore flags bare URLs (MD034) on the :link: lines #206

amotl opened this issue May 19, 2025 · 0 comments

Comments

@amotl
Copy link
Member

amotl commented May 19, 2025

There has been a suggestion by CodeRabbit.

🧹 Nitpick comments (1)
docs/integrate/mcp/cratedb-mcp.md (1)

26-54: Resource grid layout
The grid directive cleanly organizes the package link, usage guide, and examples. Note: markdownlint flags bare URLs (MD034) on the :link: lines—these are intentional within MyST directives and can be safely ignored or suppressed with <!-- markdownlint-disable MD034 --> if required.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

30-30: Bare URL used
null

(MD034, no-bare-urls)


39-39: Bare URL used
null

(MD034, no-bare-urls)


47-47: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 563017b and 88c4cb5.

📒 Files selected for processing (1)
  • docs/integrate/mcp/cratedb-mcp.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
docs/integrate/mcp/cratedb-mcp.md (3)
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/cratedb-mcp.md:3-8
Timestamp: 2025-05-18T13:39:58.358Z
Learning: In MyST Markdown, the correct syntax for rubric directives in the CrateDB documentation is:
```
:::{rubric} Title
:::
```
followed by the content outside of the directive. This is different from other admonition blocks where content is typically wrapped inside the directive.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/cratedb-mcp.md:12-21
Timestamp: 2025-05-18T13:39:51.994Z
Learning: In MyST Markdown, the correct syntax for rubric directives is to close the directive immediately after the title, rather than wrapping the content:
```
:::{rubric} Title
:::

Content goes here (outside the directive)
```
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/cratedb-mcp.md:3-8
Timestamp: 2025-05-18T13:39:58.358Z
Learning: In MyST Markdown, the rubric directive is used for informal headings and doesn't wrap content. The correct syntax is:
```
:::{rubric} Title
:::
```
followed by the content outside of the directive. This differs from admonition blocks which do wrap their content.
🪛 markdownlint-cli2 (0.17.2)
docs/integrate/mcp/cratedb-mcp.md

30-30: Bare URL used
null

(MD034, no-bare-urls)


39-39: Bare URL used
null

(MD034, no-bare-urls)


47-47: Bare URL used
null

(MD034, no-bare-urls)

🪛 GitHub Actions: docs
docs/integrate/mcp/cratedb-mcp.md

[warning] 57-57: 'rubric': Has content, but none permitted

🔇 Additional comments (9)
docs/integrate/mcp/cratedb-mcp.md (9)

1-2: Title Clarity and Placement
The document title accurately reflects the content and is correctly placed at the top of the page.


3-4: Correct use of rubric directive for "About"
The About section is immediately closed after the title, adhering to the MyST rubric syntax.


6-11: Concise overview in the "About" section
This text clearly summarizes the CrateDB MCP Server’s purpose and introduces the MCP protocol effectively.


12-13: Correct use of rubric directive for "Introduction"
The Introduction rubric is closed immediately after the title, matching the expected MyST pattern.


15-21: Clear and informative introduction
These lines effectively explain how the MCP Server bridges AI assistants and CrateDB clusters using natural language.


23-24: Correct rubric usage for "What's inside"
The "What's inside" section is properly annotated as a rubric with an immediate closing.


59-64: Example conversation clarity
The sample dialog and accompanying screenshot effectively demonstrate real-world usage.


66-72: Proper use of caution directive
The caution block clearly warns about the experimental status and is formatted correctly.


74-75: Verify MCP protocol link
Ensure that the reference URL for the MCP specification is current and correct.

Please confirm that https://modelcontextprotocol.io/ is the authoritative endpoint for the MCP documentation.

Originally posted by @coderabbitai[bot] in #204 (review)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant