purescript / purescript/pursuit
Provide anchor links on instances
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 174
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
Suggestion from @joneshf. Now that instance docs are displayed, it makes a lot more sense to provide a (#) link which points to a specific instance, for sharing the URL. E.g. https://pursuit.purescript.org/packages/purescript-prelude/3.1.0/docs/Data.Functor#v:functorArray
Contributor guide
No contributing guide indexed for this repository
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
First check whether instance documentation and the requested URL pattern still exist, since this issue has been inactive for years. Then locate the code that renders instance documentation and compare its links with the example URL; done means each instance has a shareable anchor link without breaking existing documentation navigation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100