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

Cats Microsite: add Github Links #2862

Closed
diesalbla opened this issue May 27, 2019 · 5 comments · Fixed by #4401
Closed

Cats Microsite: add Github Links #2862

diesalbla opened this issue May 27, 2019 · 5 comments · Fixed by #4401
Assignees
Labels
documentation good first issue Issues that are easier to take on for first time contributors help wanted

Comments

@diesalbla
Copy link
Contributor

The cats microsite has several pages explaining the data types. It would be useful if each of them could add a link to the page in the Github source code where that data structure is defined.

E,g: Chain doc and Chain code

@diesalbla diesalbla changed the title Microsite: add Github Links Cats Microsite: add Github Links May 27, 2019
@kailuowang kailuowang added documentation good first issue Issues that are easier to take on for first time contributors help wanted labels May 27, 2019
@erwan
Copy link

erwan commented Jun 30, 2019

Is it something that should be done manually on each page or is there a way to leverage the source header already present in most page?

(What is this header currently used for by the way?)

@vasiliybondarenko
Copy link
Contributor

I guess it can be automated using header:

---
layout: docs
title:  "Eval"
section: "data"
source: "core/src/main/scala/cats/Eval.scala"
scaladoc: "#cats.Eval"
---

@vasiliybondarenko
Copy link
Contributor

Can I create PR?

@reardonj
Copy link
Contributor

I can take a look at this, though personally I'd rather links to the scaladocs than the source code.

Laika has support to generate API & source links. API links can be configured straight from the tlSiteApiUrl setting, which makes me wonder if that step would be more useful to do right in TypelevelSitePlugin. I didn't see an obvious analog for source links, but maybe there is a setting elsewhere? Thoughts?

@armanbilge
Copy link
Member

Thanks for your interest!

which makes me wonder if that step would be more useful to do right in TypelevelSitePlugin

Indeed! We had a PR that was looking into this, I would be very happy to see that effort revived :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue Issues that are easier to take on for first time contributors help wanted
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

6 participants