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

link style in docs: github vs yard #57

Closed
ConorSheehan1 opened this issue Dec 3, 2018 · 2 comments
Closed

link style in docs: github vs yard #57

ConorSheehan1 opened this issue Dec 3, 2018 · 2 comments

Comments

@ConorSheehan1
Copy link
Contributor

I just came accross this issue on yard lsegal/yard#1017
Basically github requires this style of link [changelog](CHANGELOG.md) but yard requires this {file:CHANGELOG.md}

I changed the links in the readme to work on github in pr #53
Now the link works in the github readme, but it's broken in the docs on rubygems.
If you go to the readme on rubygems and follow the link to the changelog, you'll get a not found error for changes.md

Do you think the fix provided in the issue would make sense for spira?
Or should we choose between github or yard style links?

@gkellogg
Copy link
Member

gkellogg commented Dec 3, 2018

Documentation should live on rubydoc.info as it does for other ruby-rdf projects, but the README doesn't show this.

In general, IMHO, we should optimize for yard, and point there from the README. I'll update the README with a section on this.

gkellogg added a commit that referenced this issue Dec 3, 2018
ConorSheehan1 added a commit to ConorSheehan1/spira that referenced this issue Dec 3, 2018
@ConorSheehan1
Copy link
Contributor Author

Makes sense to me, I'll revert that link

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