Gedinakova/api links generation#1928
Conversation
gedinakova
added
area: enhancement
MayaKirova
left a comment
MayaKirova
left a comment
There was a problem hiding this comment.
In general:
- Could we maybe not keep copies of the json files here as well?
Maybe the build process can pull the jsons from the other repo, or wherever we want to permanently keep the files.
- Do we plan on removing the old apiMap.json files and legacy handling?
The whole fallback and handling logic is all very nice, with 700 lines of read me explanations on how it all works, but do we really need it? Could we just have the mappings to the new api, using the jsons and scrap all the legacy stuff?
| * | ||
| * ╔══════════════════════════════════════════════════════════════════════╗ | ||
| * ║ TEMPORARY — remove this file (and its references in ║ | ||
| * ║ TypeDocApiResolver.ts) once Blazor ships a real TypeDoc JSON. ║ |
There was a problem hiding this comment.
Blazor cannot ship a typedoc json, since typedoc only works on typescript and Blazor is c#.
kindString should stay.
| * The caller is responsible for indexing the returned entries into | ||
| * the lookup maps. | ||
| */ | ||
| export function parseBlazorDocFxJson( |
There was a problem hiding this comment.
Structure changed a bit to include the namespaces at the root of each package. Latest jsons can be found here: https://github.com/IgniteUI/api-docs/pull/11
Might have to change the handling due to the additional level of hierarchy.
| */ | ||
| export function buildBlazorUrl(apiRoot: string, typeInfo: TypeDocTypeInfo): string { | ||
| const ns = typeInfo.namespace ?? 'IgniteUI.Blazor.Controls'; | ||
| return `${apiRoot}${ns}.${typeInfo.name}.html`; |
There was a problem hiding this comment.
Not sure this will be the format of the urls for the new docs. Currently we don't use the namespace as part of the urls. See: https://github.com/IgniteUI/api-docs/pull/11
IMO, definitely, yes! But this was not in scope for the current task.
Hopefully that's the next step 👍 As long as there're no strong opinions against :) |
|
Auto-tagged as stale status because no activity in the last 30 days. |
2 participants
No description provided.