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

Proposal: Handle readme.md and README.md Equally for Cross-Platform Consistency #2813

Closed
fxi opened this issue Nov 8, 2024 · 2 comments
Closed

Comments

@fxi
Copy link

fxi commented Nov 8, 2024

When publishing to GitHub via an action, the readme.md was not rendered as index.html, but as readme.html. It worked fine locally. It took me a while to understand that pkgdown is case-sensitive (as it should be), but macOS and Windows users, by default, use a case-insensitive file system. This can cause some confusion, especially for files where both case notations are accepted, like readme.md and README.md.

I think pkgdown should take this into account.

@hadley
Copy link
Member

hadley commented Nov 8, 2024

This feels like a risky precedent to me, because if we allow this for README.md then people will expect it for _pkgdown.yml and lots of other files. It's a bummer that it caused you some confusion, but I don't think modifying the package is going to decrease net confusion. Even though I'm closing this issue, I really appreciate the feedback, and hope you'll continue to contribute in the future 😄

@hadley hadley closed this as completed Nov 8, 2024
@fxi
Copy link
Author

fxi commented Nov 8, 2024

Absolutely. I just realized this might be the first time I ever used a lowercase readme.md or encounter similar issue. Temporary lapse of clarity on my part. Appreciate all the hard work you put into maintaining half the R ecosystem 👍

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

No branches or pull requests

2 participants