style: drop trailing-whitespace and callout-blank-line format rules#771
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
dosubot
Bot
added
size:M
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation formatting rules and their deterministic linters by removing enforcement of trailing-whitespace checks and “blank line before/after Mintlify callouts” checks, aligning the prose guide and both EN/CJK format-check skills.
Changes:
- Remove the “one blank line before/after callout component” requirement from the formatting guide.
- Delete Mintlify callout surrounding-blank-line violations (
M-component-blank-before/after) from both EN and CJK format-check linters and their SKILL rule indices. - Drop trailing-whitespace detection (
S-trailing-whitespace) from both EN and CJK format-check linters and their SKILL rule indices.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| writing-guides/formatting-guide.md | Removes callout blank-line requirement and updates the general spacing rule accordingly. |
| .claude/skills/dify-docs-format-check-en/check-format-en.py | Removes M-component-blank-before/after callout checks and S-trailing-whitespace detection from the EN linter. |
| .claude/skills/dify-docs-format-check-en/SKILL.md | Removes the deleted rule IDs from the EN skill’s documented rule list. |
| .claude/skills/dify-docs-format-check-cjk/check-format-cjk.py | Removes callout blank-line checks and trailing-whitespace detection from the CJK linter. |
| .claude/skills/dify-docs-format-check-cjk/SKILL.md | Removes the deleted rule IDs from the CJK skill’s documented rule list. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
S-trailing-whitespaceandM-component-blank-before/M-component-blank-afterfrom both format-check linters (check-format-en.py,check-format-cjk.py) and their SKILL.md rule indices.writing-guides/formatting-guide.md: the per-callout "one blank line before and after the component" line and thebefore/after componentsclause in the general Spacing rule.