Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Address confusion with links to old package versions #414

Open
milesfrain opened this issue Jul 10, 2020 · 0 comments
Open

Address confusion with links to old package versions #414

milesfrain opened this issue Jul 10, 2020 · 0 comments

Comments

@milesfrain
Copy link

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.
milesfrain added a commit to milesfrain/documentation-1 that referenced this issue Jul 10, 2020
@milesfrain
Add derive via Generic example, and point to latest docs
69cc5ec 
I often visit this page looking for a `genericShow` example.

It was also frustrating to click on the `Data.Generic.Rep` and be taken to an older package version that's missing lots of nice documentation. So ensuring links now go to the latest version. (related to purescript/pursuit#414)
@milesfrain milesfrain mentioned this issue Jul 10, 2020
Merged
hdgarrood pushed a commit to purescript/documentation that referenced this issue Jul 11, 2020
@milesfrain
Add derive via Generic example, and point to latest docs (#331)
081ec82 
* Add derive via Generic example, and point to latest docs

I often visit this page looking for a `genericShow` example.

It was also frustrating to click on the `Data.Generic.Rep` and be taken to an older package version that's missing lots of nice documentation. So ensuring links now go to the latest version. (related to purescript/pursuit#414)

* Clarify `derive` and more details on `Generic`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@milesfrain