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 README links in the README files #24

Open
aholmes opened this issue Oct 20, 2023 · 0 comments
Open

Fix README links in the README files #24

aholmes opened this issue Oct 20, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation priority:2 Standard priority issue

Comments

@aholmes
Copy link
Member

aholmes commented Oct 20, 2023

This links to individual libraries point to src/<lib>/README.md. These are the wrong URLs everywhere except when navigating from within the monorepo. There are several other incorrect URLs in the individual library READMEs as well.

A temporary solution may be to change the URLs to the full HTTP URL for github, or for PyPI. A longer term solution may be to re-write the URLs during package building so the PyPI-uploaded packages point to the correct location, and the files in the repo remain unchanged and point within the repo.

@aholmes aholmes added the documentation Improvements or additions to documentation label Oct 20, 2023
@aholmes aholmes self-assigned this Oct 20, 2023
@aholmes aholmes changed the title Fix README links in the root README files Fix README links in the README files Oct 20, 2023
@aholmes aholmes added the priority:2 Standard priority issue label Feb 12, 2024
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 priority:2 Standard priority issue
Projects
None yet
Development

No branches or pull requests

1 participant