Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR significantly simplifies the README.md by removing detailed getting started instructions and compatibility guidelines in favor of directing users to the dedicated Getting Started guide on the project wiki. The change makes the README more concise and focused on essential links rather than duplicating comprehensive documentation.
- Replaced lengthy in-line tutorial with a direct link to the Getting Started guide
- Removed compatibility guidelines table and Java/Gradle version requirements section
- Streamlined the introductory content to focus on navigation to comprehensive documentation
README.md
Outdated
|
|
||
| - The [ml-gradle Wiki](https://github.com/marklogic/ml-gradle/wiki) guides you through all of the ml-gradle documentation | ||
| - Read the [Getting Started guide](https://github.com/marklogic/ml-gradle/wiki/Getting-started) for more details on setting up a new project | ||
| - The [ml-gradle Wiki](https://github.com/marklogic/ml-gradle/wiki) guides you through all the ml-gradle documentation |
There was a problem hiding this comment.
The word 'the' is missing before 'ml-gradle documentation'. It should read 'all the ml-gradle documentation' to match the original text and maintain grammatical consistency.
Mostly pointing to Getting Started guide now.
rjrudin
force-pushed
the
feature/readme-update
branch
from
ad8f6ed to
654a536
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.
Mostly pointing to Getting Started guide now.