fix: replace use of tsdocs.dev by typedoc generated markdown #30
Conversation
This file contains 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
…/interactive-bridge-api TODO: Figure out how to deduplicate the file headers whilst avoiding use of anchor tags for internal linking.
TODO: Ensure stripping double titles with sed also works on linux; not just in Mac OS TODO: Produce plain from schema in index.d.ts i.e: no z.infer<typeof ..> but just a type with documented properties Perhaps just don't use that and repeat ourself in schema.ts to once define the type with tsdoc and separately the zod schema to validate that.
Work around Zod infer losing property tsdoc. And similarly around Zod schema parse losing parent type. TODO: Do this for all other schema types and validate functions. Or just for the object types?
Inferring types from Zod schema's is nice, but results in ugly types in index.d.ts. And typedoc doesn't support those, even with the help of typedoc-plugin-zod. And a little more type related tweaking.
ci-liveryvideo
pushed a commit
that referenced
this pull request
Feb 26, 2024
## [1.12.3](v1.12.2...v1.12.3) (2024-02-26) ### Bug Fixes * replace use of tsdocs.dev by typedoc generated markdown ([#30](#30)) ([912924f](912924f))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Ticket: https://exmachina.atlassian.net/browse/LIV-2806