Document Docusaurus markdownlint exceptions - #32
Merged
Brett Curtis (brettcurtis) merged 1 commit intoApr 20, 2026
Conversation
Documents why MD041 and MD046 are disabled in this repo (front matter, MDX/admonition mixed code-block styles) by adding a Markdown Lint section to the repo copilot instructions. Also applies trailing-newline fixes that pre-commit's end-of-file-fixer surfaced on existing docs pages. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
WalkthroughThis PR adds a new "Markdown Lint" section to the Copilot instructions documenting Docusaurus-specific linting rules and removes trailing blank lines from multiple platform team documentation files for consistency. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/copilot-instructions.md:
- Around line 5-13: The PR adds a "Markdown Lint" section and new exceptions
MD041 and MD046 to .github/copilot-instructions.md which violates the
requirement that this file be identical across platform repos; remove the entire
"Markdown Lint" section (the table and any references to MD041 and MD046) so the
file matches the canonical copilot-instructions.md used by the platform team,
leaving only the original, approved disabled rules (MD013, MD033, MD045).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d028f87e-1780-47ef-aeba-f95a19d70001
⛔ Files ignored due to path filters (1)
.markdownlint.jsonis excluded by!**/*.json
📒 Files selected for processing (10)
.github/copilot-instructions.mddocs/platform-teams/arche/core-helpers.mddocs/platform-teams/arche/module-development.mddocs/platform-teams/corpus/index.mddocs/platform-teams/ekklesia/documentation.mddocs/platform-teams/kryptos/index.mddocs/platform-teams/logos/index.mddocs/platform-teams/logos/team-topology.mddocs/platform-teams/pneuma/index.mddocs/platform-teams/pneuma/observability.md
💤 Files with no reviewable changes (9)
- docs/platform-teams/corpus/index.md
- docs/platform-teams/arche/core-helpers.md
- docs/platform-teams/logos/team-topology.md
- docs/platform-teams/logos/index.md
- docs/platform-teams/pneuma/index.md
- docs/platform-teams/arche/module-development.md
- docs/platform-teams/pneuma/observability.md
- docs/platform-teams/ekklesia/documentation.md
- docs/platform-teams/kryptos/index.md
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.
Documents the repo-specific markdownlint disables in
.github/copilot-instructions.md:MD041— Docusaurus pages start with YAML front matter, not a headingMD046— MDX admonitions and components mix fenced and indented code blocksFound during a workspace-wide audit against the platform instructions, which only list
MD013/MD033/MD045as disabled. The two extras are intentional Docusaurus accommodations and now documented as such.Also includes trailing-newline fixes that
pre-commitsurfaced on 9 pre-existing docs pages.Summary by CodeRabbit
Release Notes
Documentation
Style