Repository navigation
More consistent language READMEs - #1483
Merged
Merged
Conversation
bgentry
approved these changes
Oct 9, 2026
Comment on lines
+12
to
+21
| <dependency> | ||
| <groupId>com.riverqueue</groupId> | ||
| <artifactId>river</artifactId> | ||
| <version>0.48.0-alpha.1</version> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.postgresql</groupId> | ||
| <artifactId>postgresql</artifactId> | ||
| <version>42.7.12</version> | ||
| </dependency> |
Contributor
Author
There was a problem hiding this comment.
Yeah :( They really should've dropped this at some point.
We have a little problem where the various language READMEs aren't all doing the same thing. Some contain user instructions, others development instructions. Here, make them explicitly intended for user-facing docs and move any internal development content to `docs/development.md` in each directory. Changes: * Java: Mostly usage examples already. Moved contributor instructions to `java/docs/development.md`. * JavaScript: Similar. Moved API-doc generation command. * Ruby: Mostly links and contributor commands. Added installation instructions and example. Moved contributor commands. * Rust: Most workspace/development workflow. Added installation instructions, example, features, and crate links. Move other content.
brandur
force-pushed
the
brandur-more-consistent-readmes
branch
from
October 10, 2026 04:09
579544d to
6944737
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
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.
We have a little problem where the various language READMEs aren't all
doing the same thing. Some contain user instructions, others development
instructions. Here, make them explicitly intended for user-facing docs
and move any internal development content to
docs/development.mdineach directory.
Changes:
Java: Mostly usage examples already. Moved contributor instructions to
java/docs/development.md.JavaScript: Similar. Moved API-doc generation command.
Ruby: Mostly links and contributor commands. Added installation
instructions and example. Moved contributor commands.
Rust: Most workspace/development workflow. Added installation
instructions, example, features, and crate links. Move other content.