kripod
Readme link mulfunction
Thanks for reporting!
The top-level README.md file isn't malfunctioning, but symlinked to ./packages/glaze/README.md, which GitHub shows explicitly in its per-file view.
If you wish to clone the repository on Windows, please refer to the contribution guide, which links an article about setting things up.
Maybe I did explained well. Go to https://github.com/kripod/glaze Click the view all of readme. See a sentence ./packages/glaze/README.md Instead of readme
Look, I know where is the readme, I found it, but only after going there manually.
From a user perspective first time landing on the repo and want to read the readme. The expected behaviour is click on the view all and view the readme. Where the user currently sees only the sentence, not a link and not a readme.
See screenshot. It doesn't happen on any other repo. Just trying to help.
I do care for sure, but the rendering of symlinks is the responsibility of the underlying platform (GitHub in this case, or the OS on developers’ machines).
The readme in this monorepo’s root is linked to packages/glaze/README.md. Please refer to it from mobile or file an issue to GitHub for a better experience!
I do view it from mobile. I think user experience is preferred. I mean, the amount of people wanting to use this repo will be less in this situation when they cannot view the readme. I suppose it is not only me, everybody will encounter that and will walk away.
I’ll try my best to revive the issue filed to GitHub above. The README displayed belongs to the glaze package and needs to be packed along with the package.json file during deployments.
As requested, I’ll also try reversing the symlink direction, fixing the issue temporarily.
As requested, I’ll also try reversing the symlink direction, fixing the issue temporarily.
I tried this, but had to conclude that npm pack doesn't account for the symlinked readme in packages/glaze. Unfortunately, this has to be resolved by GitHub. Thank you for reporting!
I visited the repo from a mobile browser (ref’ed from twitter), tried to access the readme, couldn’t, I knew what’s going on but I was simply too lazy to navigate thru the file explorer on a mobile device.
So instead, I clicked on Issues to file an issue and I ended up here.
Perhaps that gives you an idea how much extra work it is to access the readme with broken symlinking (Github’s fault, I know). Filing an issue is less work than to go through the file explorer on a mobile.
@anilanar Thank you for the heads-up! I will work on this once after adding customizable options for gatsby-plugin-treat.