typelevel / typelevel/cats-effect
Incorrect OpenGraph tags on the docs page
Open
Nobody has claimed this yet.
:books: docs
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
Looking at https://typelevel.org/cats-effect/docs/tracing#enhanced-exceptions, for example, I see:
<meta property="og:image" content="https://typelevel.org/cats-effect/img/undraw_online.svg">, which returns 404<meta name="twitter:image" content="https://typelevel.org/cats-effect/img/undraw_tweetstorm.svg">, which also returns 404<meta property="og:url" content="https://typelevel.org/cats-effect/">, which I'm not sure is the intended URL (at least I find it confusing to not jump to the "Tracing" page, since theog:titleis "Tracing · Cats Effect")
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Cats Effect tracing documentation page at https://typelevel.org/cats-effect/docs/tracing#enhanced-exceptions and inspect how its OpenGraph and Twitter metadata is generated. Verify the referenced image URLs and the og:url value; the work is done when those metadata values resolve correctly and point to the intended tracing page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100