dio icon indicating copy to clipboard operation
dio copied to clipboard

Update dio library doc

Open mcmah309 opened this issue 1 year ago • 7 comments

Not sure why these exist, they make the generated docs look squirrely https://pub.dev/documentation/dio/latest/dio/

mcmah309 avatar Dec 22 '24 00:12 mcmah309

Could you elaborate "squirrely"?

AlexV525 avatar Dec 22 '24 04:12 AlexV525

"Migration Guide" and "Plugins" point to the same location and are just the regular docs for the dio library. It does not make sense to have these as categories.

The side view currently looks like this -

Libraries browser io   Migration Guide   dio   Plugins   dio

While it should look like

Libraries browser dio io

mcmah309 avatar Dec 22 '24 05:12 mcmah309

Maybe the problem is library dio should be library only.

AlexV525 avatar Dec 22 '24 05:12 AlexV525

I don't see how that would remove the unnecessary categories.

But we may have to remove https://github.com/cfug/dio/blob/b16a611a14b8b8a4cb7f2556628a5f030c315ffd/dio/dartdoc_options.yaml#L4 as well. I think the changes in this PR are enough though.

mcmah309 avatar Dec 22 '24 05:12 mcmah309

These are necessary topics IMO. Is there a proper way to keep them while removing the extra library entries?

AlexV525 avatar Dec 22 '24 05:12 AlexV525

I don't think the changes in this PR will remove the topics. Just the sub-categories under "Libraries". "Topics" should remain the same.

mcmah309 avatar Dec 22 '24 05:12 mcmah309

Unfortunately, the topics are gone after removing these categories. Maybe this should be tracked with a Dart doc issue?

image

AlexV525 avatar Dec 25 '24 10:12 AlexV525