typelevel / typelevel/sbt-typelevel
A way to preview scaladocs
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Scala
- Stars
- 185
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
You can build them locally and point a static file server at them. Not sure if sbt has a built-in way of doing this, but this should be a straightforward and helpful thing to implement in sbt-typelevel.
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 by examining how sbt-typelevel currently builds Scaladoc and whether sbt provides a built-in preview or static file-server workflow. Confirm the desired local preview behavior and identify the project entry points involved; done means users can build and preview Scaladoc through a documented sbt-typelevel workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100