softwaremill / softwaremill/tapir

Consider rewriting documentation introducing tapir to newcomers

Open
#3,268 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
1.5k
Forks
468
Avg merge
5h 37m
Merged PRs (30d)
34

Description

  • gather feedback from newcomers to tapir, which parts of the docs where helpful, and what was missing
  • rewrite / split / expand / reorganize depending on the outcome of the above

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

No files, tests, or documentation entry points are named. Start by gathering feedback from newcomers about which parts of the tapir documentation were helpful and what was missing. Done means rewriting, splitting, expanding, or reorganizing the documentation based on that feedback.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.