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

Fix broken documentation links #1435

Merged
merged 2 commits into from
Oct 26, 2016
Merged

Fix broken documentation links #1435

merged 2 commits into from
Oct 26, 2016

Conversation

liff
Copy link
Contributor

@liff liff commented Oct 26, 2016

/tut/ leads to a 404.

@peterneyens
Copy link
Collaborator

HI @liff, thanks for spotting this.

grep "tut/" -r --exclude-dir "*target*" cats/ gives us a lot of similar errors, but I will open another issue for this.

@liff
Copy link
Contributor Author

liff commented Oct 26, 2016

I can add fixes for the other broken links in this PR if that's OK?

@peterneyens
Copy link
Collaborator

Of course, that would be great.

@codecov-io
Copy link

codecov-io commented Oct 26, 2016

Current coverage is 92.19% (diff: 100%)

Merging #1435 into master will not change coverage

@@             master      #1435   diff @@
==========================================
  Files           242        242          
  Lines          3615       3615          
  Methods        3546       3546          
  Messages          0          0          
  Branches         69         69          
==========================================
  Hits           3333       3333          
  Misses          282        282          
  Partials          0          0          

Powered by Codecov. Last update 08b72eb...0a22699

@liff
Copy link
Contributor Author

liff commented Oct 26, 2016

Here you go.

There's one more broken link to Arrow.scala in the FAQ but I'm not sure where it should point to exactly.

@liff liff changed the title Fix OptionT documentation link Fix broken documentation links Oct 26, 2016
@peterneyens
Copy link
Collaborator

I think we lost {{ site.sources }} with the new site (It was in this removed file).

We can probably fix that in another PR.

@non
Copy link
Contributor

non commented Oct 26, 2016

👍 Thanks for fixing this!

@peterneyens
Copy link
Collaborator

👍

@peterneyens peterneyens merged commit 4e63279 into typelevel:master Oct 26, 2016
DieBauer added a commit to DieBauer/cats that referenced this pull request Dec 15, 2018
As stated by typelevel#1435 (comment) the `{{ site.sources }}` configuration item was lost. 

Already 6 occurrences exist in the docs that link directly to `https://github.com/typelevel/cats/blob/master`. 
In all documentation, this was the only place where `sources` was still used, so instead of adding a [custom yaml](https://47deg.github.io/sbt-microsites/docs/settings.html) and keep the tightly coupling with Jekyll, I've replaced this one instance with another hard-coded link to master.
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

Successfully merging this pull request may close these issues.

4 participants