-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
#320 Define types and interfaces in docs #347
Merged
Merged
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
lukasmatta
requested review from
fateeand,
korel-san,
TerranceKhumalo-absa and
AtlegangMolokwane
as code owners
February 29, 2024 16:46
fateeand
approved these changes
Feb 29, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, can you please create a ticket for the second part (as subtask of #74)
Let's also include there the issue regarding removal of API for internal components and support of API generation for directives (table, tree table).
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.
Added support for Types and Interfaces. One can navigate to type/interface by clicking on it, it navigates to the proper page section and highlights the Type/Interface for a moment. Note that it works only for simple types,
MyType
orMyType[]
. To support this, each page's route is now split into/example
and/api
.To be able to retrieve the location of the Type/Interface in a constant time, I introduced
types_map.json
file that is generated together with other .json files. The file serves as a key-value mapping in which Type/Interface name is a key and its location is a value.Future work (issues I'm aware of but might be a bit time-consuming to implement):
CpsDialogConfig
)typedoc
issue) as using Interface workstypeof iconNames[number]
is not handled properlyMyType
orMyType[]
but also for more complicated types, e.g. in typeRecord<string, MyType>
, or in genericMyType<any>
, we want to makeMyType
clickable if it is defined somewhere in the docs. Ideally, this should be parsed AOT to not affect runtime performance.