Repository files navigation

https://fsharp.github.io/fsharp-compiler-docs

To improve the content of the FSharp.Compiler.Service library documentation, contribute to the XML/// documentation in thesignature files (*.fsi) in the FSharp.Compiler.Service implementation.

• Fork and clonehttps://github.com/dotnet/fsharp locally, see below

• Contribute tosrc/fsharp directory andsrc/fsharp directory and submit work tomain branch ofdotnet/fsharp

• Once accepted your work will be published through a rebuild here. A rebuild is triggered daily at 17:30 UTC or you can trigger it yourself by submitting a dummy change.

The docs are generated by usingfsdocs tool from FSharp.Formatting.

Eventually the build will just be

dotnet tool restoredotnet restore FSharp.Compiler.Servicedotnet fsdocs build

For now, we make a fresh build of FSharp.Compiler.Service.

(start in fsharp-compiler-docs)dotnet restore FSharp.Compiler.Servicedotnet tool restore(make fsharp-compiler-docs/fsharp)git clone https://github.com/dotnet/fsharp --depth 1 -b main(build fsharp-compiler-docs/fsharp) pushd fsharpdotnet build src/Compiler/FSharp.Compiler.Service.fsproj /p:BUILDING_USING_DOTNET=truepopd

Then do iterative development using:

(from fsharp-compiler-docs)dotnet fsdocs watch --sourcefolder fsharp  --input fsharp/docs

This repo is published via GitHub Actions. On each push to main, the docs are built, and the outputs (which are written to theoutput directory by fsdocs) are pushed to thegh-pages branch. This repo is configured to host using GitHub Pages from this branch.