typelevel / typelevel/sbt-typelevel
Laika/Helium extension for redirecting to versioned docs
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Scala
- Stars
- 185
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
First demoed this idea in https://github.com/http4s/http4s-jdk-http-client/pull/582.
<!DOCTYPE html>
<meta charset="utf-8">
<meta http-equiv="refresh" content="0; URL=0.7">
<link rel="canonical" href="0.7">
Which itself was grabbed from this gist:
https://gist.github.com/domenic/1f286d415559b56d725bee51a62c24a7
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 reviewing the referenced http4s-jdk-http-client pull request and the linked gist, then inspect this repository for its Laika/Helium or documentation integration points. Done means the extension redirects documentation pages to the appropriate version and emits the refresh and canonical HTML shown in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100