Open
Description
This is a tracking issue for myself, @KathleenDollard and the F# community to track missing F# docs and other improvements we can make. Contributions are welcome
This is all about the docs at https://docs.microsoft.com/dotnet/fsharp/
Specific work items up-for-grabs
- Tutorials
- string programming
- regex programming
- list programming
- "Tour of F#" is weak and needs rejig
- Language guide
- Indentation-aware syntax, have requested to add this content as a new page: https://fsharpforfunandprofit.com/posts/fsharp-syntax/
- Using Dictionary
- Add overview of .NET collections (Dictionary, List etc.)
- Add overview of object programming
- Add section on MailboxProcessor
- F# core library
- Tools
-
Visual Studio Enterprise code coverage is great but needs configuration, see https://docs.microsoft.com/en-us/visualstudio/test/customizing-code-coverage-analysis?view=vs-2022. Pardticularly need to add
<Attribute>^System\.Runtime\.CompilerServices\.CompilerGeneratedAttribute</Attribute>
-
- Architecture guide
Problems identified
- No tutorials on string processing, .NET types (strings, collections, web requests...) etc
- The "tour" uses long chunks of code with discursive text in comments. It is too long and not compelling.
- The language guide is half-guide, half-reference. We make it more "guide" while keeping the reference material
- Language guide is misssing some important overview sections like "object programming"
- Native interop using
NativePtr
is not covered - Generic .NET material like https://docs.microsoft.com/dotnet/ contains very few F# references. We can update this.
Completed work items
- Language guide is not organized Organize F# language guide toc/index, add F# scenarios #26804
- Document primary scenarios (web development, machine learning, azure) Organize F# language guide toc/index, add F# scenarios #26804