posit-dev / posit-dev/great-docs
Preview changes in object signature in dev
@rich-iannone is already working on this.
Since Apr 19, 2026.
- Dominant language
- Python
- Stars
- 262
- Forks
- 18
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 14
Description
For multi-version docs, we have many authoring possibilities for specifying what’s new in which versions in guide pages and other sections. We also plan to show upcoming features with section badges in such pages. (UPDATE: implemented in dev).
Taking this further, in the reference section, there may be API changes that users will want to know about in an upcoming version. For this type of situation, we should present a view of an upcoming state of the object signature (perhaps flagging specifically which parts are new, changed, or removed). This could be a great help for users of a library to be on top of API changes that affect their workflows.
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.
Assessment
This issue has not been assessed yet.