lasp / lasp/hapi-server

Docs for http4s-circe show up in our docs

Open
#23 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
1
Forks
1
Avg merge
1d 7h
Merged PRs (30d)
3

Description

Some of the documentation for org.http4s.circe shows up in our documentation.

Specifically, the page for the org.http4s.circe package is present, and the page for the org.http4s.circe.MessageSyntax class is listed in the index but not actually present.

Contributor guide

No contributing guide indexed for this repository

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

Locate the documentation-generation inputs for the org.http4s.circe package and compare them with the generated package page and index entry for org.http4s.circe.MessageSyntax. Done means removing the unwanted documentation and ensuring the MessageSyntax index entry matches the pages that are actually generated.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.