dotnet / dotnet/docs

F# docs planning

Open
#26,813 2 comments 3 reactions 0 assignees View on GitHub
dotnet-fsharp/svc
Dominant language
No language data
Stars
4.8k
Forks
6.1k
Avg merge
19h 10m
Merged PRs (30d)
268

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
* [ ] https://github.com/dotnet/fsharp/issues/12124
* 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

```

^System\.Runtime\.CompilerServices\.CompilerGeneratedAttribute
```
* Architecture guide
* [ ] We can add an F# architecture guide under the .NET architecture guides [here](https://docs.microsoft.com/dotnet/) and [here](https://docs.microsoft.com/dotnet/architecture/)

## 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

* [x] Language guide is not organized #26804
* [x] Document primary scenarios (web development, machine learning, azure) #26804

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.