Skip to content
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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

steelswords
Copy link

The README files in docs/ had some broken links. This fixes them.

Signed-off-by: Tristan Andrus tristan@tristanandrus.com

Signed-off-by: Tristan Andrus <tristan@tristanandrus.com>
@NiKiZe
Copy link
Collaborator

NiKiZe commented Jan 1, 2023

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:
Copy link
Collaborator

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?

@steelswords
Copy link
Author

I think the problem is that the READMEs in the docs directory seem to be slightly modified copies of the README files in the main directory. When you go to view the readmes in docs, those links are broken. So I only changed those links. I left the READMEs in the main directory unchanged. I assumed since there were some slight differences between the two sets, that the duplication was intentional.

@crankyoldgit
Copy link
Owner

I think the problem is that the READMEs in the docs directory seem to be slightly modified copies of the README files in the main directory. When you go to view the readmes in docs, those links are broken. So I only changed those links. I left the READMEs in the main directory unchanged. I assumed since there were some slight differences between the two sets, that the duplication was intentional.

If view the page via https://github.com/crankyoldgit/IRremoteESP8266/tree/gh-pages it seems to work as expected.
So it does seem to be viewer-URL specific problem. What URL are you using that gives you the error?

TL;DR: There may not be a perfect solution to this. Perhaps a fully qualified URL is required.

@NiKiZe
Copy link
Collaborator

NiKiZe commented Mar 1, 2023

Can I again ask how you are viewing these files and how they are causing issues?
Some copying is done as part of the release process, but should probably not conflict with these changes, but I do want to fully understand where this is an issue.

Documentation of release process: https://github.com/crankyoldgit/IRremoteESP8266/wiki/Library-Maintainers-Guide#new-version-release-checklist

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants