locationtech / locationtech/geotrellis
Add scaladoc to mdoc build
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Scala
- Stars
- 1.4k
- Forks
- 360
- Avg merge
- 6h 57m
- Merged PRs (30d)
- 12
Description
See instructions at https://scalameta.org/mdoc/docs/docusaurus.html#include-scaladoc-in-site
There may be some dragons here, as the docs at that link use docusaurus v1 (not v2) and we're not using the docusaurus sbt plugin.
Contributor guide
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 with the linked mdoc instructions for including Scaladoc, then inspect GeoTrellis's mdoc build and its Docusaurus setup. Account for the documented Docusaurus v1 guidance, the project's v2 usage, and the absence of the sbt plugin; done means the mdoc site build includes the generated Scaladoc.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100