lsegal on 09 Oct, 2019 11:05 PM
You should be able to resolve this with:
The readme switch is a bit of an old one and there might be a bug on rubydoc.info not respecting it. If you mark the file as an "extra file" (any files listed after the -) it should keep the file around to serve it. You can see an example of this in https://github.com/lsegal/yard/blob/master/.yardopts
lsegal on 10 Oct, 2019 08:37 PM
So it looks like a couple of other projects have been dealing with this same issue. Still working on diagnosing the root issue but I've temporarily unblocked your project and you should now be seeing the README along with correct master fork info. This means that you should be able to apply your .yardopts settings to get the other extra files displaying.
The problem may come back over the next day or two but rest assured we're investigating. I will keep this open and close when we've identified the root issue and are sure that this won't come back.
Thanks! I'd love to move this getting started stuff back out of the main README though. It uses yard syntax so is kind of confusing when viewed from GitHub. Should I try to do that again, or should I wait? do you think the problem was with my library in particular or with some larger issue with yardopts?