typelevel / typelevel/fs2

Add UTF-8 file transcode example app to site/docs

Open
#2,063 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted
Dominant language
Scala
Stars
2.5k
Forks
636
Avg merge
2d 4h
Merged PRs (30d)
7

Description

Not sure where exactly but it would be nice to include these types of apps in docs and ensure they stay compiling as we evolve APIs.

https://gist.github.com/djspiewak/b1bfa4f7fe30bdd0ead89f5286f9ad06

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 by reviewing the linked gist and the existing site/docs structure to find the appropriate location and conventions for example apps. Done means the UTF-8 file transcode example is included in the documentation and remains compiling as the APIs evolve.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.