Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Fix README.md links #115

Closed
wants to merge 2 commits into
from

Conversation

Projects
None yet
2 participants

jshou commented Sep 21, 2012

The links will now work from the repo home page. Relevant: github/markup#101

Joshua Hou added some commits Sep 21, 2012

Contributor

TylerBrock commented Sep 21, 2012

Thanks. We want to make this change but it breaks the ydocs on api.mongodb.org. Discussed it today and we might wind up removing these files from that site to keep it api only, in which case we would definitely pull this. Hold tight.

jshou commented Sep 21, 2012

Oh, that explains it. In that case, maybe we want to pull the API links from this readme as well?

Contributor

TylerBrock commented Sep 21, 2012

Yeah, if you can figure out a way to make ydoc generate links that work for for both api.mognodb.org as well as github it would be awesome. I tried to get it to work but apparently github doesn't support repo relative links (which I think are necessary). Any ideas?

jshou commented Sep 21, 2012

I tried for a bit to get relative links as well, to no avail. With my pull, if you view "README.md" as a file (https://github.com/mongodb/mongo-ruby-driver/blob/master/README.md) none of the links work either. Maybe the solution is to just keep them separate and have the github README point to api.mongodb.org?

Contributor

TylerBrock commented Sep 21, 2012

Yeah, its a well known problem on github: github/markup#84 (comment)

We are going to change it, possibly for the C driver as well. Please hold tight for a bit, need to discuss with others at 10gen.

@brandonblack brandonblack referenced this pull request Oct 9, 2012

Closed

Update README.md #122

Contributor

TylerBrock commented Oct 17, 2012

We are going to move to Wiki style documentation instead using Github. Thanks though!

@TylerBrock TylerBrock closed this Oct 17, 2012

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment