Link README to the new configuration guide#8
Open
st0012 wants to merge 1 commit into
Open
Conversation
st0012
temporarily deployed
to
fork-preview-protection
GitHub Actions
Inactive
Add a top-level Configuration section that summarizes the four configuration mechanisms (.rdoc_options, RDoc::Task, RDOCOPT, .document) and points to the published configuration guide. Trim the markup-format and theme-options sections to keep one example each, recommending .rdoc_options for persistent settings instead of per-invocation CLI flags. Links use the official site URL so they work from anywhere the README is rendered (rubygems.org, gem index pages, etc.).
st0012
force-pushed
the
claude/update-readme-config-guide-u0rz4
branch
from
998a350 to
10d377d
Compare
st0012
temporarily deployed
to
fork-preview-protection
GitHub Actions
Inactive
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
2 participants
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.
Add a top-level Configuration section that introduces the four mechanisms (
.rdoc_options,RDoc::Task,RDOCOPT,.document) and links to the published guide. Trim the duplicated.rdoc_optionsand CLI restatements from the markup-format and theme-options sections, and recommend.rdoc_optionsover the--markupflag for persistent configuration.Links use the official site URL so they resolve from rubygems.org and other places the README is rendered outside the repo.