typelevel / typelevel/sbt-typelevel
Simplify configuring "related projects" nav area
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 185
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
Right now adding related projects is very verbose (and not well documented); https://github.com/typelevel/sbt-typelevel/blob/2e825717aa73582cc5ac4e79021b9a479bec40c4/build.sbt#L223-L242
It would be nice if we had a setting key so we can do something like;
tlSiteRelatedProjects ++= Seq("http://example.com" -> "example")
Having the more powerful version available is nice, but doing the most common thing should be easy
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 reading the related-projects configuration in build.sbt around lines 223-242 and the surrounding issue discussion. Add a setting that supports the shown tlSiteRelatedProjects syntax while keeping the more powerful existing configuration available; done means the concise form works for common related-project links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- build-system, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100