optics-dev / optics-dev/Monocle
Upgrade to docusorus v2 for Scala 2/3 code samples
Open
Nobody has claimed this yet.
3.x
- Dominant language
- Scala
- Stars
- 1.7k
- Forks
- 207
- Avg merge
- 7h 59m
- Merged PRs (30d)
- 5
Description
Docusaurus v2 lets us define code samples in tabs, so we could have one tab for Scala 2 and one for Scala 3.
https://v2.docusaurus.io/docs/markdown-features#customizing-tabs
Contributor guide
No contributing guide indexed for this repository
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 by locating the repository's documentation configuration and the existing Scala code samples. Read the linked Docusaurus v2 tabs documentation, then determine how the samples should be separated for Scala 2 and Scala 3. Done means the documentation builds with distinct tabs showing the appropriate examples.
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
- Mostly clear
- Newbie friendliness
- 38/100