website icon indicating copy to clipboard operation
website copied to clipboard

Determine pattern of tooling go links and create important ones

Open parlough opened this issue 1 year ago • 1 comments

If you have destinations you currently (or would like to) link to from tooling, please comment here with the destination/topic/reason or similar. Thanks!

parlough avatar Apr 04 '24 19:04 parlough

These are the URLs I found in the Dart-Code currently (some are Dart, but since I had them I thought I'd post them for completeness):

  • https://dart.dev/get-dart
  • https://dart.dev/tools/dart-devtools
  • https://dart.dev/tools/pub/glossary#system-cache
  • https://docs.flutter.dev/f/flutter-survey-metadata.json
  • https://docs.flutter.dev/get-started/install/linux#update-your-path
  • https://docs.flutter.dev/get-started/install/macos#update-your-path
  • https://docs.flutter.dev/get-started/install/windows#update-your-path
  • https://flutter.dev/docs/development/tools/web-renderers
  • https://flutter.dev/setup/
  • https://api.flutter.dev/flutter/${sample.libraryName}/${sample.className}-${suffix}.html${fragment}

The last one is used to power the "Open interactive sample" CodeLens feature. We get the library/classname from the analyzers Outline data (and use class, mixin or extension-type as a suffix based on the element kind, and build a matching fragment like "widgets.RestorationMixin.1" to scroll down to the embedded sample.

DanTup avatar Apr 09 '24 11:04 DanTup

In the various linked PRs, I've added tooling /to/ links for links already used in the tool and framework, and with https://github.com/flutter/flutter/commit/b6cd31e6b5a61125ef0e78d866af673f404a84ea, https://github.com/flutter/flutter/blob/main/docs/contributing/use-reliable-links.md now has guidelines on adding and using them.

parlough avatar Aug 16 '24 10:08 parlough