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

Update README to point to correct examples #286

Open
ntessore opened this issue Sep 27, 2024 · 4 comments
Open

Update README to point to correct examples #286

ntessore opened this issue Sep 27, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@ntessore
Copy link
Collaborator

Which Section of the Documentation Needs Improving?

README

What Can be Improved About This Section

The README still points to the external examples which have been sunset.

How to Improve This Section

The README should point to the new in-place examples. There's a question whether this should point to latest (good for the repository) or to stable (good for the PyPI page, although even better would be pointing to the correct version, which seems a lot of work for very little gain).

@ntessore ntessore added the documentation Improvements or additions to documentation label Sep 27, 2024
@paddyroddy
Copy link
Member

@ntessore the README on main doesn't do this. Are you looking at PyPI? That will be because a release hasn't been made since the change

@ntessore
Copy link
Collaborator Author

I mean this link here

[examples]: https://glass.readthedocs.io/projects/examples/

@paddyroddy
Copy link
Member

Okay, understood. So it should really point to https://glass.readthedocs.io/stable/examples.html, which doesn't exist yet. I could change it to that now so that it is ready when a release is made?

@ntessore
Copy link
Collaborator Author

I wonder if we shouldn't point the README to glass.readthedocs.io/latest in all three places, then put a conditional

sed -i "s|https://glass.readthedocs.io/latest|https://glass.readthedocs.io/$(git describe --tags)|" README.md

in there when the sdist is built for distribution.

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

No branches or pull requests

2 participants