docs: add @since TypeDoc tags, drop versioned documentation#936
Draft
barjin wants to merge 1 commit into
Draft
Conversation
janbuchar
reviewed
Jun 11, 2026
Comment on lines
+135
to
+137
| /** | ||
| * @since Added in 2.0.1 | ||
| */ |
Contributor
There was a problem hiding this comment.
This seems redundant — no way the property could've been added before the interface itself... right?
Member
Author
There was a problem hiding this comment.
Yes... but I'd have everything explicit rather than implementing some unclear "distributive" logic in the plugin. The @since tag in TypeDoc doesn't have any deeper logic behind it (docs).
Some of the docblocks now look rather repetitive; this is something I'm hoping will change with the OpenAPI-generated clients (and the docs team's initiative to have better docblocks, as briefly discussed recently).
Contributor
There was a problem hiding this comment.
Can we at least hide these repeated ones in the rendered docs?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Drops the Docusaurus-based versioned documentation and adds the
@sincetags to the JSDoc blocks. These are rendered as shown below ⬇️The main issue remains the need for manual updates of the
@sincetags on new symbols. The initial seeding was done by a script - perhaps we could add this to the CI?This is an experimental PR as a follow-up to an internal Tooling team discussion.