Skip to content

Document Docusaurus markdownlint exceptions - #32

Merged
Brett Curtis (brettcurtis) merged 1 commit into
mainfrom
align-with-platform-instructions
Apr 20, 2026
Merged

Document Docusaurus markdownlint exceptions#32
Brett Curtis (brettcurtis) merged 1 commit into
mainfrom
align-with-platform-instructions

Conversation

@brettcurtis

@brettcurtis Brett Curtis (brettcurtis) commented Apr 20, 2026

Copy link
Copy Markdown
Member

Documents the repo-specific markdownlint disables in .github/copilot-instructions.md:

  • MD041 — Docusaurus pages start with YAML front matter, not a heading
  • MD046 — MDX admonitions and components mix fenced and indented code blocks

Found during a workspace-wide audit against the platform instructions, which only list MD013/MD033/MD045 as disabled. The two extras are intentional Docusaurus accommodations and now documented as such.

Also includes trailing-newline fixes that pre-commit surfaced on 9 pre-existing docs pages.

Summary by CodeRabbit

Release Notes

  • Documentation

    • Enhanced documentation with comprehensive guidance on Markdown linting rules and platform-specific exceptions. Added detailed explanations of how these configurations support the documentation framework's unique formatting requirements and content presentation capabilities.
  • Style

    • Improved documentation formatting consistency by removing trailing whitespace from documentation files across multiple platform modules. These changes ensure standardized document structure and presentation throughout the documentation set.

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>
@coderabbitai

coderabbitai Bot commented Apr 20, 2026

Copy link
Copy Markdown

Walkthrough

This 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

Cohort / File(s) Summary
Copilot Instructions Enhancement
.github/copilot-instructions.md
Added "Markdown Lint" section documenting disablement of MD041 and MD046 rules for Docusaurus-specific Markdown linting requirements.
Documentation Trailing Whitespace Cleanup
docs/platform-teams/arche/core-helpers.md, docs/platform-teams/arche/module-development.md, docs/platform-teams/corpus/index.md, docs/platform-teams/ekklesia/documentation.md, docs/platform-teams/kryptos/index.md, docs/platform-teams/logos/index.md, docs/platform-teams/logos/team-topology.md, docs/platform-teams/pneuma/index.md, docs/platform-teams/pneuma/observability.md
Removed trailing blank lines at end of files across multiple domain documentation pages.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

documentation

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: documenting Docusaurus markdownlint exceptions in the copilot-instructions file, which is the primary objective of the PR.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6420371 and 28651dd.

⛔ Files ignored due to path filters (1)
  • .markdownlint.json is excluded by !**/*.json
📒 Files selected for processing (10)
  • .github/copilot-instructions.md
  • docs/platform-teams/arche/core-helpers.md
  • docs/platform-teams/arche/module-development.md
  • docs/platform-teams/corpus/index.md
  • docs/platform-teams/ekklesia/documentation.md
  • docs/platform-teams/kryptos/index.md
  • docs/platform-teams/logos/index.md
  • docs/platform-teams/logos/team-topology.md
  • docs/platform-teams/pneuma/index.md
  • docs/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

Comment thread .github/copilot-instructions.md
@brettcurtis
Brett Curtis (brettcurtis) merged commit 91549ac into main Apr 20, 2026
3 checks passed
@brettcurtis
Brett Curtis (brettcurtis) deleted the align-with-platform-instructions branch April 20, 2026 22:38
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