typelevel / typelevel/doobie

The link "here" on the first page of the docs is not working

Open
#2,148 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation
Dominant language
Scala
Stars
2.2k
Forks
379
Avg merge
14m
Merged PRs (30d)
8

Description

Where to find the source page:

https://typelevel.org/doobie/index.html

Scroll down to the bottom:

The source code for this page can be found [here](https://github.com/tpolecat/doobie/tree/v1.0.0-RC4/modules/docs/target/mdoc/index.md).

The actual link here is pointing to 404 page.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the documentation source at modules/docs/target/mdoc/index.md and compare it with the rendered first page at https://typelevel.org/doobie/index.html. Check the bottom “here” link and update the documentation reference so it resolves successfully, then verify the rendered link no longer returns 404.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.