Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR improves markdown parsing for YARD documentation by switching from the default markdown parser to Redcarpet. The change enhances documentation generation, particularly for lists and other markdown elements in both README.md and generated YARD documentation.
Key changes:
- Updated markdown parser configuration to use Redcarpet for more reliable rendering
- Regenerated documentation with improved formatting, especially for list structures
- Added Redcarpet as a development dependency for consistent markdown processing
Reviewed Changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Gemfile | Added redcarpet gem as development dependency |
| .yardopts | Configured Redcarpet as the markdown provider and removed exclusions |
| README.md | Enhanced content structure with better formatting and additional sections |
| docs/* | Regenerated documentation files with improved markdown parsing and timestamps |
Comments suppressed due to low confidence (1)
Gemfile:23
- The version constraint '
> 3.6' for redcarpet may be too restrictive. As of my last knowledge update in January 2025, redcarpet version 3.6 was current, but newer versions may be available in August 2025. Consider using a more flexible constraint like '> 3.0' or checking for the latest stable version.
gem 'redcarpet', '~> 3.6'
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.
This pull request introduces significant improvements to the documentation, feature set, and development infrastructure of the
mtg_card_makergem. Key updates include enhanced README content, better YARD documentation generation, and the addition of advanced features for card customization and development workflows.Documentation Enhancements:
README.mdwith clearer feature descriptions, advanced customization options, and a new "Technical Architecture" section. This includes improved explanations of mana support, sprite sheet features, and development benefits. [1] [2] [3] [4]redcarpetmarkup provider and removing outdated exclusions in.yardopts.docs/MtgCardMaker/BaseCard.htmlto improve readability and consistency. [1] [2] [3] [4]Feature Additions:
Development Infrastructure:
redcarpetgem to the development environment for improved markdown rendering in documentation.README.mdto highlight the benefits of using Guard for automated testing and code quality monitoring.These changes collectively improve the usability, maintainability, and appeal of the
mtg_card_makergem for both developers and end users.Fixes #50