Include changelog history for each operator on their doc page
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 31.7k
- Forks
- 3k
- PR merge metrics
- No merged PRs in 30d
Description
Please check those that apply
- typo
- documentation doesn't exist
- documentation needs clarification
- error(s) in example
- needs example
Description Of The Issue
I personally find it increasingly difficult to keep track of what operator behavior has changed in what version and I always have to search through CHANGELOG.md.
So it made me thinking that the API documentation for each operator could include a section with all changes ordered by RxJS version (ideally with links to relevant issues and PRs). CHANGELOG.md already has each line starting with scope so this could work automatically by "just" creating another dgeni processor.
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 by inspecting CHANGELOG.md to understand its scope and version format, then review the existing API documentation generation and dgeni processors. Done means each operator's documentation page includes its changes ordered by RxJS version, with links to relevant issues and pull requests where available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100