Flurl icon indicating copy to clipboard operation
Flurl copied to clipboard

Updates to documentation

Open tmenier opened this issue 8 years ago • 7 comments

For tracking updates and changes needed to the docs. I welcome community input here!

https://flurl.io/installation/

  • [x] Update supported platforms https://flurl.io/installation
  • [x] Mention Flurl.Http.Xml

https://flurl.io/fluent-url/

  • [ ] Url.Combine enhancements

https://flurl.io/testable-http/

  • [ ] Query param assertions #102
  • [ ] Can test in parallel (except PCL)
  • [ ] Misc enhancements from 1.1.0 & 1.1.1

https://flurl.io/configuration/

  • [ ] Url is a Flurl.Url object, not a string

https://flurl.io/docs/client-lifetime/#using-flurl-with-an-ioc-container

  • [ ] Do NOT advise configuring FlurlClient in service ctor - it's not thread safe. When ConfigureClient is added to FlurlClientFactory, advise using that in service registration as I mentioned here.

tmenier avatar Jul 28 '16 14:07 tmenier

@kroniak Could you suggest how best to document supported platforms (as of Flurl 2.2)? Here is how the docs currently read:

Both Flurl and Flurl.Http are Portable Class Libraries supporting the following platforms:

  • .NET Framework 4 and above for Flurl, 4.5 and above for Flurl.Http
  • Windows 8
  • Windows Phone 8.1
  • Windows Phone Silverlight 8
  • Xamarin.Android
  • Xamarin.iOS

I want to highlight .NET Core obviously. Do we say ".NET Core 1.0+"? What about targets such as NETStandard and UAP? They imply a collection of platforms, so they probably would not belong on this list, correct? Also MonoTouch/MonoAndroid are the same as Xamarin.iOS/Xamarin.Android, right?

We're in your world here, so any advice is appreciated!

tmenier avatar Jul 28 '16 14:07 tmenier

@tmenier I think that the best is list target as in nuget package. About netcore say "Support NETCore 1.0.0 by NETStandard target 1.4". Like so.

You write something and we will review.

kroniak avatar Jul 28 '16 17:07 kroniak

@kroniak How's this?

  • .NET Framework 4 and above for Flurl, 4.5 and above for Flurl.Http
  • .NET Core 1.0 (via .NET Standard 1.4)
  • Windows 8
  • Windows Phone 8.1
  • Windows Phone Silverlight 8
  • Xamarin.Android
  • Xamarin.iOS
  • Xamarin.Mac
  • UAP 1.0
  • MonoTouch
  • MonoAndroid

tmenier avatar Jul 29 '16 01:07 tmenier

Hard to find good examples. NUnit lists theirs: https://www.nuget.org/packages/NUnit/

tmenier avatar Jul 29 '16 01:07 tmenier

@tmenier Yep. I would have said: Minimal version:

Target Platform Name Alias Flurl Flurl.Http
.NET Platform Standard netstandard 1.4
.NET Core netcoreapp 1.0
.NET Framework net 4.0 4.5
Universal Windows Platform uap 10.0
Windows win 8.0
Windows Phone wpa 8.1
Windows Phone Silverlight wp 8.0
Mono/Xamarin Platforms
Mono

kroniak avatar Jul 29 '16 01:07 kroniak

@tmenier I'd suggest to document the work done for #222 on https://tmenier.github.io/Flurl/client-lifetime/

cremor avatar Jun 09 '18 11:06 cremor

@cremor Agreed. Also noted in #330.

tmenier avatar Jun 11 '18 21:06 tmenier