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

Confusing/Incorrect Documentation #67

Closed
myztillx opened this issue Feb 2, 2024 · 4 comments
Closed

Confusing/Incorrect Documentation #67

myztillx opened this issue Feb 2, 2024 · 4 comments

Comments

@myztillx
Copy link
Contributor

myztillx commented Feb 2, 2024

Describe the Bug
Why is all the README documentation about Upcoming Media Card and not plex recently added?

The Error
N/A

Indicate if you followed all steps in the troubleshooting doc
N/A

What data does the sensor display if any?
N/A

What displays when visiting the API URL from the troubleshooting guide?
N/A

Does the default Home Assistant Plex component work for you?
N/A

Home Assistant Version
N/A

Additional Context
N/A

@mkanet
Copy link
Collaborator

mkanet commented Feb 2, 2024

Hi @myztillx. The README.md for sensor.plex_recently_added hasn't changed:
https://github.com/custom-components/sensor.plex_recently_added/blob/master/README.md

However, the Upcoming Media Card's README.md has changed; since there are new features for it that were just released:
https://github.com/custom-components/sensor.plex_recently_added/blob/master/README.md

The troubleshooting doc you referenced is the troubleshooting guide for Upcoming Media Card:
https://github.com/custom-cards/upcoming-media-card/blob/master/troubleshooting.md

Let me know if there are any specific changes you would like to see in either README.md above or any other documentation changes.

@myztillx
Copy link
Contributor Author

myztillx commented Feb 2, 2024

Following your first link (https://github.com/custom-components/sensor.plex_recently_added/blob/master/README.md) the title of the readme is Upcoming Media Card. It seems it might have been changed in error when updating Upcoming Media Cards readme.

The troubleshooting guide I linked was just part of the issue template when I opened this issue.

@mkanet
Copy link
Collaborator

mkanet commented Feb 2, 2024

Thanks for catching that! I think I might have inadvertently changed the title by accident. I just fixed it:

https://github.com/custom-components/sensor.plex_recently_added/blob/master/README.md

@mkanet mkanet closed this as completed Feb 2, 2024
@myztillx
Copy link
Contributor Author

myztillx commented Feb 2, 2024

It seems that be934a8 was the commit that caused the errors and changed the Plex readme to the Upcoming Media readme. Not just the title is different; the entire readme is wrong.

Yes, that's where I made my mistake. I attempted to correct my mistake right away in a subsequent update; however, I had missed changing the title back.

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

No branches or pull requests

2 participants