Update AI instructions, tweak markdown linting #156
Merged
Conversation
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
- Clarify the MCP guide writer subagent's instructions - Only enforce prose wrap requirement for docs/ - Refactor markdownlint rule locations Signed-off-by: Dan Barr <6922515+danbarr@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors markdown linting configuration and updates AI instructions to improve documentation quality and clarity. The changes streamline the markdownlint setup by consolidating rules and creating directory-specific configurations, while also clarifying instructions for AI agents working on the documentation.
Key changes:
- Reorganized markdownlint configuration to be more targeted and hierarchical
- Updated Prettier configuration to only enforce prose wrapping in docs/ directory
- Enhanced AI agent instructions with clearer guidelines and review processes
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
docs/toolhive/_partials/.markdownlint.json |
Updated extends path to reference parent directory configuration |
docs/toolhive/.markdownlint.json |
Added new configuration file with docs-specific line length rules |
README.md |
Reformatted to comply with new prose wrapping rules |
AGENTS.md |
Reformatted content and added new review process section |
.prettierrc |
Added override to only enforce prose wrapping in docs/ directory |
.markdownlint.json |
Disabled line length globally and added JSON schema reference |
.markdownlint-cli2.jsonc |
Simplified ignores list by removing GitHub-specific paths |
.github/prompts/doc-review.prompt.md |
Updated style guide reference and reformatted content |
.github/copilot-instructions.md |
File appears to be emptied |
.claude/agents/mcp-guide-writer.md |
Enhanced agent instructions with more detailed guidelines |
JAORMX
approved these changes
Sep 5, 2025
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.
Signed-off-by: Dan Barr 6922515+danbarr@users.noreply.github.com