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: switch image paths in README to perma URLs #152

Merged
merged 3 commits into from
Aug 20, 2024
Merged

Conversation

kelly-sovacool
Copy link
Member

@kelly-sovacool kelly-sovacool commented Aug 20, 2024

Changes

Switch image paths to permanent raw URLs so they will render correctly in the gh-pages site. The content from README.md gets imported directly into docs/index.md, so relative paths break.

Issues

NA

PR Checklist

(Strikethrough any points that are not applicable.)

  • This comment contains a description of changes with justifications, with any relevant issues linked.
  • [ ] Update docs if there are any API changes.
  • Update CHANGELOG.md with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/

@kopardev kopardev added the RENEE RepoName label Aug 20, 2024
@kelly-sovacool kelly-sovacool self-assigned this Aug 20, 2024
@kelly-sovacool kelly-sovacool added the documentation Improvements or additions to documentation label Aug 20, 2024
@kelly-sovacool kelly-sovacool added this to the 2024-08 milestone Aug 20, 2024
@samarth8392 samarth8392 merged commit b37f038 into main Aug 20, 2024
5 checks passed
@samarth8392 samarth8392 deleted the docs-images branch August 20, 2024 16:50
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 RENEE RepoName
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants