update: readme cleanup and fxes #4208
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
Jamstah
approved these changes
Dec 21, 2023
thaJeztah
reviewed
Dec 21, 2023
README.md
Outdated
| @@ -27,7 +27,7 @@ This repository contains the following components: | |||
| |--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | |||
| | **registry** | An implementation of the [OCI Distribution Specification](https://github.com/opencontainers/distribution-spec). | | |||
| | **libraries** | A rich set of libraries for interacting with distribution components. Please see [godoc](https://pkg.go.dev/github.com/distribution/distribution) for details. **Note**: The interfaces for these libraries are **unstable**. | | |||
| | **documentation** | Docker's full documentation set is available at [docs.docker.com](https://docs.docker.com). This repository [contains the subset](docs/) related just to the registry. | | |||
| | **documentation** | Full documentation set is available at [https://distribution.github.io/distribution](https://distribution.github.io/distribution/). This repository [contains the subset](docs/) related just to the registry. | | |||
There was a problem hiding this comment.
"documentation set" feels a bit awkward.
- Perhaps just "Documentation is available at"
- The second sentence also no longer applies, so I think that whole sentence can be removed.
There was a problem hiding this comment.
Yeah I've overlooked that. Will fix
Signed-off-by: Milos Gajdos <milosthegajdos@gmail.com>
2c4a137 to
e29a5c8
Compare
|
Just squashed, waiting for the CI and then I'll merge. |
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.
PTAL @thaJeztah @Jamstah