dartdoc version shipped with 3.2.0 has broken sidebar #54067
Comments
parlough
added
area-dart-cli
|
We generally pick commits, not pub-published versions of our DEPS dependencies, so it's not as bad as the range with 26 commits you point out, @parlough. Only 18 to get the fixes: dart-lang/dartdoc@a3cfdc4...4283dbc. I would support this cherry-pick. In that range of commits I see:
I'll also note that Flutter bumped to dartdoc 7.0.1, for generation of api.flutter.dev, with flutter/flutter@997a94f, on Oct 20. |
|
Ah, but this is of course a cherry-pick of a commit sitting in SDK main branch. So which commit do we pick? The DEPS rolls often include more than one package which would make it a much spookier cherry-pick, but luckily the commit that introduces the 3rd fix to the sidebars is 279f6d7, which includes only one more local commit (dart-lang/dartdoc@8c10339), a harmless docs change. |
|
Thanks for your thoughts and insight @srawlins. I agree that's a good commit to use and nothing in that range seems concerning. The original range included canonicalization changes, so this seems much better. I opened #54073 and https://dart-review.googlesource.com/c/sdk/+/336780, but I've never created a cherry-pick request before, so let me know if I made any mistakes. Thank you! |
Update dartdoc for missing sidebars and incorrect links in sidebars. Fixes #54067 Closes #54073 Bug: #54067 Change-Id: I19c1e5c21a293aa29bfa6c1e93f097bba1fd8faa Cherry-pick: https://dart-review.googlesource.com/c/sdk/+/330666 Cherry-pick-request: #54073 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/336780 Reviewed-by: Ben Konyi <[email protected]> Commit-Queue: Jonas Termansen <[email protected]> Reviewed-by: Samuel Rawlins <[email protected]>
|
Fixed by 50b4c43 landing in stable :) |
The left sidenav is missing on generated documentation for non-class templates/pages.
Example: https://api.dart.dev/stable/3.2.0/dart-ffi/NativeCallable/NativeCallable.isolateLocal.html
On the stable branch (3.2.0) dartdoc is at dart-lang/dartdoc@a3cfdc4.
There were a few related dartdoc fixes that landed after the beta cutoff:
dartdoc v7.0.1 should include all of these fixes, but it is a relatively wide range of commits, so I'm not sure if that's acceptable from a cherrypick perspective?
The text was updated successfully, but these errors were encountered: