rescript-lang / rescript-lang/rescript-lang.org
Show deprecation reason in stdlib docs on rescript-lang.org
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 1.9k
- Forks
- 260
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 17
Description
For example: https://rescript-lang.org/docs/manual/api/stdlib/option/#value-getWithDefault just shows a "deprecated" banner, but it doesn't show what API should be used instead.
Reading the code & in the sandbox I can see the reason:
Use getOr instead
It would be nice to also have that on the documentation website
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 with the linked stdlib documentation page and the linked Stdlib_Option.resi declaration to compare the existing deprecation banner with the available reason. Trace the documentation rendering or generation path for deprecated APIs in this repository. Done means the page shows that getWithDefault is deprecated and recommends getOr, with the documentation build or relevant checks passing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100