purescript / purescript/pursuit
Show out-of-date docs as a red badge
Open
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 174
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
If the docs are out-of-date with the Bower version, it would be nice if the badge were red. Is this possible? I guess it would need to query Bower or GitHub every time to find out, but maybe we can set Nginx to cache badges?
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
The issue names no files, tests, or entry points. First locate how badges are generated and how the documented Bower version is determined; done would require a defined way to detect outdated docs and display the badge in red without relying on unspecified caching behavior.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100