[DOC] Refresh standard libraries page #12404
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
nobu
reviewed
Dec 20, 2024
nobu
reviewed
Dec 20, 2024
st0012
force-pushed
the
refresh-standard-libraries-page
branch
from
316e942 to
4645a6a
Compare
jeremyevans
requested changes
Dec 20, 2024
There was a problem hiding this comment.
I think we should continue linking default gems to the main class of the library (as currently done on https://docs.ruby-lang.org/en/master/standard_library_rdoc.html), not using website links to GitHub repositories. It's way more friendly for users. Using web links for bundled gems is fine, as we aren't generating documentation for those, and the web link is better than the current lack of link.
st0012
force-pushed
the
refresh-standard-libraries-page
branch
from
3f6bbec to
4733fcb
Compare
That's a good call. I've restored all the autolinks but IMO it's still helpful to list their GitHub links too. Otherwise it's not easy to find that information from the generated docs either. |
jeremyevans
approved these changes
Dec 20, 2024
Co-authored-by: Jeremy Evans <code@jeremyevans.net>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
I think the standard libraries page could use a little love so I:
Result:
Screen.Recording.2024-12-20.at.11.19.16.mov
The descriptions and some libraries' placements may use some more detailed reviews, but I plan to do it in separate PRs.