feat: api ref doc sidebar optimization #1599
Conversation
xinsong-cui
changed the title
|
A new generated diff is ready to view.
|
|
A new generated diff is ready to view.
|
This comment has been minimized.
This comment has been minimized.
build.gradle.kts
Outdated
| dokkaOutputDir.listFiles { file -> | ||
| file.isDirectory && file.resolve("navigation.html").exists() | ||
| }?.forEach { moduleDir -> |
There was a problem hiding this comment.
There should only be one navigation.html file (in the root of dokkaOutputDir) since we prune the duplicate navigation.html files during our build.
There was a problem hiding this comment.
Do we still want to prune them? Now we are trimming and using these navigations
There was a problem hiding this comment.
I didn't realize your navigation loader would use each module's navigation.html. Ok, that will work but we'll need to update our build process to not remove duplicate files (and make sure the docs artifact size doesn't increase significantly)
There was a problem hiding this comment.
Yep, I'll remove that. I did a quick estimation, the doc size should only increased by 300 - 400 MB
|
A new generated diff is ready to view.
|
This comment has been minimized.
This comment has been minimized.
|
A new generated diff is ready to view.
|
This comment has been minimized.
This comment has been minimized.
|
A new generated diff is ready to view.
|
This comment has been minimized.
This comment has been minimized.
0marperez
left a comment
0marperez
left a comment
There was a problem hiding this comment.
Should we do this for smithy-kotlin as well? The navigation sidebar isn't troublesome but for consistency it would be nice to do the same.
Yeah, I agree we should keep consistency. I am open to do for smithy-kotlin. |
|
A new generated diff is ready to view.
|
This comment has been minimized.
This comment has been minimized.
|
A new generated diff is ready to view.
|
This comment has been minimized.
This comment has been minimized.
|
|
A new generated diff is ready to view.
|
Affected ArtifactsNo artifacts changed size |
4 participants
Issue #
Description of changes
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.