Migrate README to markdown #1422
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
|
🚀 Preview deployment available at: https://b042d312.rdoc-6cd.pages.dev (commit: ec2375f) |
kou
approved these changes
Sep 7, 2025
Comment on lines
-63
to
64
| s.rdoc_options = ["--main", "README.rdoc"] | ||
| s.rdoc_options = ["--main", "README.md"] | ||
| s.extra_rdoc_files += s.files.grep(%r[\A[^\/]+\.(?:rdoc|md)\z]) |
There was a problem hiding this comment.
Can we use .rdoc_options instead of duplicated configurations here?
There was a problem hiding this comment.
This option is in .rdoc_options already, so we can drop it here.
There was a problem hiding this comment.
.rdoc_options is not packaged in the gem tho. I also don't think we should use it for gem's doc options anyway because as of now .rdoc_options usually specify configs specifically for web docs.
We should probably provide clearer instructions or even APIs to help distinguish options for different environments. But I don't have any good ideas on this yet.
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.
No description provided.