Skip to content

ci: exclude mcp-server page from markdownlint - #403

Open
Marshevskyy wants to merge 1 commit into
mainfrom
ci/markdownlint-exclude-mcp-server
Open

ci: exclude mcp-server page from markdownlint#403
Marshevskyy wants to merge 1 commit into
mainfrom
ci/markdownlint-exclude-mcp-server

Conversation

@Marshevskyy

Copy link
Copy Markdown
Contributor

What/Why/How?

The markdownlint CI job fails on every PR with 4 MD007 (list indentation) errors in `docs/realm/customization/mcp-server/index.md` — see e.g. this run.

The bullets inside that page's `{% numbered-item %}` markdoc tags must stay indented: de-indenting them to satisfy MD007 makes the markdown list parser swallow the closing tags, which breaks markdoc parsing and fails the project build (verified both directions).

Since markdownlint and markdoc are irreconcilable for this file, exclude it from the lint globs — the same treatment `add-color-mode.md`, `format-image-tag.md`, and the eject-components tutorial already get.

🤖 Generated with Claude Code

The page's markdoc tags require 2-space list indentation that MD007
rejects, and de-indenting breaks markdoc tag parsing — the same reason
other markdoc-heavy pages are already excluded. Every PR currently
fails the markdownlint job on this main-branch file.

@redocly redocly Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

marketing-site AI Review: 🟢 Completed

Redocly Agent has reviewed your changes and found 2 potential issue(s).

Note

Low Risk

This PR only modifies a GitHub Actions linting workflow. The change introduces a redundant file exclusion pattern, which has no operational impact, behavior changes, or blast radius on production systems.

Overview

Attempts to exclude docs/realm/customization/mcp-server/index.md from the markdownlint CI job to prevent MD007 (list indentation) failures caused by Markdoc tag indentation requirements.

However, this exact exclusion rule was already introduced to the base branch in a recent commit. Consequently, this PR merely appends a duplicate entry for the mcp-server index file to the markdownlint globs in .github/workflows/docs-tests.yaml.

!docs/realm/customization/add-color-mode.md
!docs/realm/customization/eject-components/eject-components-tutorial/index.md
!docs/realm/customization/mcp-server/index.md
!docs/realm/customization/mcp-server/index.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Severity: Low

This line is an exact duplicate of the one directly above it. Please remove it to avoid redundancy in the workflow configuration.

!docs/realm/customization/add-color-mode.md
!docs/realm/customization/eject-components/eject-components-tutorial/index.md
!docs/realm/customization/mcp-server/index.md
!docs/realm/customization/mcp-server/index.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Severity: Medium

Excluding the entire file bypasses all linting. Instead of this addition, consider using directly in mcp-server/index.md to disable only the problematic indentation rule while keeping other checks active.

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

Successfully merging this pull request may close these issues.

1 participant