Skip to content

Fix markdown linting issues in protocol/README.md #309

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Jun 21, 2025

Resolves markdown linting errors identified in CI build for PR #308 by addressing two specific rule violations:

Issues Fixed

1. MD031/blanks-around-fences - Missing blank line before code block

Problem: Code block at line 175 was missing a required blank line before it.

Note: The agents property may not be in the TypeScript definitions. Use type assertion if needed:
+
```javascript

2. MD029/ol-prefix - Inconsistent ordered list numbering

Problem: Ordered list items in the "Adding Custom Agent Headers" section were using sequential numbering (2, 3, 4, 5, 6) instead of the consistent "1." format required by the style guide.

-2. Direct HTTP Requests
-3. Agent Naming Conventions  
-4. Adding to agents.json
-5. Testing Agent Headers
-6. Version Management
+1. Direct HTTP Requests
+1. Agent Naming Conventions
+1. Adding to agents.json
+1. Testing Agent Headers
+1. Version Management

Verification

All markdown linting issues have been resolved:

  • npm run format:documentation:check passes with 0 errors
  • ✅ Specific MD029 and MD031 rule checks pass
  • ✅ Full lint suite (npm run lint) passes successfully

These changes ensure the documentation follows consistent markdown formatting standards without affecting the content or functionality.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@Copilot Copilot AI changed the title [WIP] Fix markdownlint errors in protocol/README.md (MD031, MD029) Fix markdown linting issues in protocol/README.md Jun 21, 2025
Copilot finished work on behalf of mattheworiordan June 21, 2025 13:24
@Copilot Copilot AI requested a review from mattheworiordan June 21, 2025 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants