Unify RubyGems and Bundler documentation#9237
Merged
Conversation
…t/PULL_REQUESTS.md
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request unifies the RubyGems and Bundler documentation by consolidating separate documentation directories into a single top-level doc/ directory, eliminating duplication and improving maintainability.
Key changes include:
- Consolidating Bundler documentation from
doc/bundler/intodoc/with merged content from RubyGems documentation - Creating unified guides for contributing (CONTRIBUTING.md), policies (POLICIES.md), and development setup (GETTING_STARTED.md)
- Restructuring documentation to serve both RubyGems and Bundler contributors with a single entry point
Reviewed changes
Copilot reviewed 27 out of 29 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/rubygems/POLICIES.md | Removed - RubyGems-specific policies merged into unified doc/POLICIES.md |
| doc/rubygems/CONTRIBUTING.md | Removed - RubyGems-specific contributing guide merged into root CONTRIBUTING.md |
| doc/bundler/playbooks/TEAM_CHANGES.md | Removed - Team management content merged into doc/POLICIES.md |
| doc/bundler/documentation/WRITING.md | Removed - Writing guide merged into doc/DOCUMENTATION.md |
| doc/bundler/documentation/VISION.md | Removed - Vision content merged into doc/DOCUMENTATION.md |
| doc/bundler/documentation/README.md | Removed - Documentation overview merged into doc/DOCUMENTATION.md |
| doc/bundler/development/SETUP.md | Removed - Setup instructions consolidated into doc/GETTING_STARTED.md |
| doc/bundler/development/README.md | Removed - Development overview distributed to other unified docs |
| doc/bundler/development/PULL_REQUESTS.md | Removed - PR guidelines merged into doc/PULL_REQUESTS.md |
| doc/bundler/development/NEW_FEATURES.md | Removed - Feature process merged into doc/NEW_FEATURES.md |
| doc/bundler/contributing/README.md | Removed - Contributing overview merged into root CONTRIBUTING.md |
| doc/bundler/contributing/HOW_YOU_CAN_HELP.md | Removed - First contribution guide merged into CONTRIBUTING.md |
| doc/bundler/contributing/COMMUNITY.md | Removed - Community engagement content merged into CONTRIBUTING.md |
| doc/bundler/contributing/BUG_TRIAGE.md | Removed - Bug triage process merged into doc/ISSUE_TRIAGE.md |
| doc/bundler/README.md | Removed - Main Bundler docs index replaced by unified doc/README.md |
| doc/TROUBLESHOOTING.md | Added - Consolidated troubleshooting guide for common issues |
| doc/README.md | Added - New unified documentation index with clear navigation structure |
| doc/PULL_REQUESTS.md | Updated - Expanded with Bundler-specific guidelines and merge process |
| doc/POLICIES.md | Updated - Unified policies covering both RubyGems and Bundler, including LTS, compatibility, and team changes |
| doc/NEW_FEATURES.md | Added - Consolidated guide for requesting and contributing new features |
| doc/ISSUE_TRIAGE.md | Added - Comprehensive issue triage guide with label documentation |
| doc/GETTING_STARTED.md | Added - Complete setup guide covering both RubyGems and Bundler development |
| doc/DOCUMENTATION.md | Added - Unified documentation guide covering RubyGems guides and Bundler man pages |
| doc/DEBUGGING.md | Updated - References updated to point to new GETTING_STARTED.md location |
| bundler/README.md | Updated - Simplified with updated documentation links |
| CONTRIBUTING.md | Updated - Comprehensive unified contribution guide for the monorepo |
Comments suppressed due to low confidence (5)
doc/POLICIES.md:3
- Line 3 refers to "the Bundler project" specifically, but this document now covers both RubyGems and Bundler (as indicated by the title). Consider updating this to refer to "the RubyGems and Bundler projects" or "the ruby/rubygems project" for consistency.
doc/POLICIES.md:26 - The apostrophe in "GitHubs" should be "GitHub's" (possessive form requires an apostrophe).
doc/POLICIES.md:1 - The title "ruby/rubygems Policies" should be "RubyGems and Bundler Policies" or "ruby/rubygems Project Policies" for better clarity and consistency with the unified documentation approach. The repository name format "ruby/rubygems" is a technical GitHub identifier, not typically used in document titles.
doc/POLICIES.md:118 - Line 118 refers to "the Bundler team" specifically, but since this is now a unified policies document for both RubyGems and Bundler, consider updating this to "the maintainers" or "the ruby/rubygems team" for consistency.
doc/PULL_REQUESTS.md:31 - The example username
@hsbtis inconsistent with the previous example that used@indirect. Consider using a generic example like@usernamefor consistency, or keep the same example as before.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+44
to
+50
| - **Report bugs or suggest features**: [Open an issue](https://github.com/ruby/rubygems/issues/new?labels=Bundler&template=bundler-related-issue.md) (see [new features documentation](bundler/development/NEW_FEATURES.md)) | ||
| - **Improve documentation**: Contribute to the [Bundler website](https://bundler.io) or [man pages](https://bundler.io/man/bundle.1.html) | ||
| - **Triage issues**: [Check issue completeness](doc/ISSUE_TRIAGE.md) and help close incomplete reports | ||
| - **Write tests**: Add failing tests for [reported bugs](https://github.com/ruby/rubygems/issues) or backfill missing test coverage | ||
| - **Review pull requests**: Provide feedback on [pull requests](https://github.com/ruby/rubygems/pulls) | ||
| - **Improve code**: No patch is too small—fix typos, improve code clarity, or clean up whitespace | ||
| - **Contribute features**: See [adding new features](bundler/development/NEW_FEATURES.md) |
There was a problem hiding this comment.
The reference to "bundler/development/NEW_FEATURES.md" should be updated to "doc/NEW_FEATURES.md" since the documentation has been reorganized to the top-level doc directory.
Suggested change
| - **Report bugs or suggest features**: [Open an issue](https://github.com/ruby/rubygems/issues/new?labels=Bundler&template=bundler-related-issue.md) (see [new features documentation](bundler/development/NEW_FEATURES.md)) | |
| - **Improve documentation**: Contribute to the [Bundler website](https://bundler.io) or [man pages](https://bundler.io/man/bundle.1.html) | |
| - **Triage issues**: [Check issue completeness](doc/ISSUE_TRIAGE.md) and help close incomplete reports | |
| - **Write tests**: Add failing tests for [reported bugs](https://github.com/ruby/rubygems/issues) or backfill missing test coverage | |
| - **Review pull requests**: Provide feedback on [pull requests](https://github.com/ruby/rubygems/pulls) | |
| - **Improve code**: No patch is too small—fix typos, improve code clarity, or clean up whitespace | |
| - **Contribute features**: See [adding new features](bundler/development/NEW_FEATURES.md) | |
| - **Report bugs or suggest features**: [Open an issue](https://github.com/ruby/rubygems/issues/new?labels=Bundler&template=bundler-related-issue.md) (see [new features documentation](doc/NEW_FEATURES.md)) | |
| - **Improve documentation**: Contribute to the [Bundler website](https://bundler.io) or [man pages](https://bundler.io/man/bundle.1.html) | |
| - **Triage issues**: [Check issue completeness](doc/ISSUE_TRIAGE.md) and help close incomplete reports | |
| - **Write tests**: Add failing tests for [reported bugs](https://github.com/ruby/rubygems/issues) or backfill missing test coverage | |
| - **Review pull requests**: Provide feedback on [pull requests](https://github.com/ruby/rubygems/pulls) | |
| - **Improve code**: No patch is too small—fix typos, improve code clarity, or clean up whitespace | |
| - **Contribute features**: See [adding new features](doc/NEW_FEATURES.md) |
e4514f2 to
6a98e39
Compare
6a98e39 to
7e2fd47
Compare
7b26ed4 to
18d2e30
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
18d2e30 to
924038e
Compare
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.
We have two separated documents for RubyGems and Bundler. These have a lot of duplicated infomation. I unified them to the top of
doc/directory.The remained issues: