purescript / purescript/pursuit

Address confusion with links to old package versions

Open
#414 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
174
Forks
47
PR merge metrics
No merged PRs in 30d

Description

There are lots of links in docs pointing to old package versions on pursuit, and this leads to confusion. Some ideas to improve this situation are discussed in this Discourse thread and include:

  • Replace the version number in the url with latest (unless explicitly linking to a version). This is what Elm does.
  • Add a visual indicator when not browsing the latest version. Either a floating header or background.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Discourse thread and inspect how Pursuit documentation URLs encode package versions. Compare the proposed latest-version links and visual indicator approaches, then confirm the chosen behavior for explicit version links and browsing older versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.