docs: fix broken hyperlink to examples #3730
Merged
Conversation
This file contains 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
|
Hi @nateprewitt, @jonemo could you kindly take a look at this small PR? |
jonemo
suggested changes
Jun 29, 2023
docs/source/guide/examples.rst
Outdated
| @@ -23,7 +23,7 @@ To propose a new code example for the AWS documentation team to consider produci | |||
| The team is looking to produce code examples that cover broader scenarios and use cases, | |||
| versus simple code snippets that cover only individual API calls. For instructions, see | |||
| the "Proposing new code examples" section in the | |||
| `Readme on GitHub <https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/README.rst>`_. | |||
| `Readme on GitHub <https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/README.md>`_. | |||
There was a problem hiding this comment.
Suggested change
| `Readme on GitHub <https://github.com/awsdocs/aws-doc-sdk-examples/blob/master/README.md>`_. | |
| `Readme on GitHub <https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/README.md>`_. |
Signed-off-by: emmanuel-ferdman <emmanuelferdman@gmail.com>
|
@jonemo no worries. I have changed to |
jonemo
approved these changes
Jul 2, 2023
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.
PR Summary:
This PR addresses a broken hyperlink present in the documentation that should direct users to the README file within the
aws-doc-sdk-examplesrepository. The issue arose from a change in the README file's format (note this PR) - it was transitioned fromREADME.rsttoREADME.md. Therefore, this PR modifies the hyperlink to correctly direct to the updatedREADME.mdfile.