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

ReadTheDocs.io page is out of date. #420

Closed
alanmcruickshank opened this issue Sep 25, 2024 · 5 comments
Closed

ReadTheDocs.io page is out of date. #420

alanmcruickshank opened this issue Sep 25, 2024 · 5 comments

Comments

@alanmcruickshank
Copy link

It looks like the readthedocs.io page for this project is out of date (https://diff-cover.readthedocs.io/en/latest/README.html). From what I can tell from the git blame of README.rst, it looks like the link broke at least 3 months ago (i.e. the changes from #410 are not included).

For now we're updating the SQLFluff docs to point directly at the GitHub repo, but I thought I should let you folks know that it looks like something has gone wrong with the readthedocs integration.

@Bachmann1234
Copy link
Owner

Yep, checking this out now

@Bachmann1234
Copy link
Owner

hey @alanmcruickshank im kinda leaning to just keeping the readme as is. Will that cause any downsides for yall?

I looked into reviving the readthedocs setup and while its not too bad im worried its gonna introduce more complexity and another place to remember to bump the version.

Are there benefits if the readme is the only docs?

@alanmcruickshank
Copy link
Author

@Bachmann1234 - I think Readme on the GitHub repo is fine 👍 . If you're not planning on reviving the readthedocs setup, perhaps could I suggest taking it down? It it's current state it just adds more confusion.

Given it was just a single page before, it doesn't seem like you lose much by just directing people to GitHub 🤷‍♂️

Thanks for maintaining this project! ❤️ Much appreciated.

@Bachmann1234
Copy link
Owner

@Bachmann1234 - I think Readme on the GitHub repo is fine 👍 . If you're not planning on reviving the readthedocs setup, perhaps could I suggest taking it down? It it's current state it just adds more confusion.

Given it was just a single page before, it doesn't seem like you lose much by just directing people to GitHub 🤷‍♂️

Thanks for maintaining this project! ❤️ Much appreciated.

Should already be down. I deleted the project when I was looking into how to fix the build.

@alanmcruickshank
Copy link
Author

Should already be down. I deleted the project when I was looking into how to fix the build.

image

Confirmed. Awesome. Will close this issue 👍

Thanks again!

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