New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix links in docs/README*.md #1941
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Tristan Andrus <tristan@tristanandrus.com>
Did you visit the individual files to get the incorrect link, or where did you see this? I think these has been corrected before, from the links this PR is trying to change to, and it depends on how the readers are viewed. |
@@ -43,15 +43,15 @@ cd ~/Arduino/libraries/IRremoteESP8266 && git pull | |||
``` | |||
|
|||
## Contributing | |||
If you want to [contribute](.github/CONTRIBUTING.md#how-can-i-contribute) to this project, consider: | |||
- [Reporting](.github/CONTRIBUTING.md#reporting-bugs) bugs and errors | |||
If you want to [contribute](../.github/CONTRIBUTING.md#how-can-i-contribute) to this project, consider: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes in this file would break the main page links, that is when you don't look at the specific file.
Does any other project have any kind of fix for this, or do we need absolute paths?
I think the problem is that the READMEs in the |
If view the page via https://github.com/crankyoldgit/IRremoteESP8266/tree/gh-pages it seems to work as expected. TL;DR: There may not be a perfect solution to this. Perhaps a fully qualified URL is required. |
Can I again ask how you are viewing these files and how they are causing issues? Documentation of release process: https://github.com/crankyoldgit/IRremoteESP8266/wiki/Library-Maintainers-Guide#new-version-release-checklist |
The README files in
docs/
had some broken links. This fixes them.Signed-off-by: Tristan Andrus tristan@tristanandrus.com