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.md: fix reference & similar tools links #48

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

Conversation

james-pcdr
Copy link

So, I know this fixes them on github.com, but will it break your github.io?

@tandav
Copy link
Owner

tandav commented Aug 5, 2024

Thank you for highlighting the broken link. Yes, this change will break the link on the documentation page at https://tandav.github.io/pipe21/.

I'll try to find out how to configure MkDocs to use the README file from the root of the repo. I do not want to add a duplicate docs/README.md file if the only difference is relative links. Maybe some sed replacement in the CI job will work.

@james-pcdr
Copy link
Author

Got it. I'd like to someday learn the CI job semantics, but today is not the day 🙂

Feel free to close this PR.

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.

2 participants