Solving issue no. #82, Links broken due to movement of the 2024 badge code to the eink folder #83
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses issue #82 by fixing broken documentation links in eink/tutorial.md that were caused by the reorganization of the 2024 badge code into the eink/ folder. The changes update absolute path references to include the /eink/ prefix so they correctly point to the relocated documentation and examples.
Key changes:
- Updated absolute links to reference files after they were moved to the
eink/directory - Fixed links to the examples folder and 2040 reference documentation
| ## Keep Playing | ||
|
|
||
| Now that you've loaded your first app, reconnect the badge to your computer and load some more! Each subfolder of this repository's [examples](examples) folder has a different app. Simply copy all the files from that subfolder directly into the "examples" directory on your badge. For example, open [examples/copilot](examples/copilot) here, and copy **copilot-book.txt**, **copilot.py**, and **icon-copilot.jpg** right into the **examples** folder of your badge. Now you have a GitHub Copilot cheat sheet available anytime you need it! | ||
|
|
There was a problem hiding this comment.
The relative links to examples, examples/copilot should be updated to absolute paths /eink/examples and /eink/examples/copilot for consistency with the other link fixes in this PR. The relative paths would not work correctly when viewed from the repository root.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pull request updates the documentation links in the
eink/tutorial.mdfile to ensure they correctly reference files within theeinkdirectory. This improves navigation and prevents broken links for users following the tutorial.Documentation fixes:
/examplesto/eink/examplesin the introduction section./2040reference.mdto/eink/2040reference.mdin both the loading program section and the closing suggestion to dig deeper.This summary is generated by copilot.