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 rendering of package information on the pkgdown website #42

Merged
merged 4 commits into from
Dec 17, 2024

Conversation

cforgaci
Copy link
Contributor

@cforgaci cforgaci commented Dec 16, 2024

@fnattino, I noticed a few issues with the rendered pkgdown website: the image links on the landing page are broken and the Changelog page is empty.

I made the necessary changes following the pkgdown guidelines on images/figures and the news section. These fixes still fall under the release we just made, right?

@cforgaci cforgaci requested a review from fnattino December 16, 2024 22:36
Copy link
Contributor

@fnattino fnattino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much @cforgaci! Well, this is actually the first PR after 0.1.0 has been released, so I would say let's add the first entry in NEWS.md under the # Unreleased section :) (and I think this should go under ## Fixed?).

NEWS.md Outdated

## [0.1.0] - 2024-12-16
# rcoins 0.1.0 - 2024-12-16
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to add the name of the package here, since it will appear for all releases?

Copy link
Contributor Author

@cforgaci cforgaci Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried # 0.1.0 and # v0.1.0 too but I cannot build the news page that way. However, it works with # Version 0.1.0. Would that be a good alternative?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah weird, I was only wondering why - looks good to me!

Copy link
Contributor

@fnattino fnattino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect, thank you so much!

NEWS.md Outdated

## [0.1.0] - 2024-12-16
# rcoins 0.1.0 - 2024-12-16
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah weird, I was only wondering why - looks good to me!

@cforgaci cforgaci merged commit 83317bb into main Dec 17, 2024
4 checks passed
@cforgaci cforgaci deleted the fix-pkgdown-cf branch December 17, 2024 18:10
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