Merge pull request #83 from lsaudon/main

Bump Workflows and fix markdown files

Author: dsyme

.github/workflows/docs.yml

@@ -3,45 +3,44 @@ name: Release docs
 on:
   schedule:
     # Triggers the workflow every day at 17:30 UTC
-    - cron:  '30 17 * * *'
+    - cron: "30 17 * * *"
   push:
     branches:
       - main
   workflow_dispatch:
 
 jobs:
   build:
-
     strategy:
       matrix:
         os: [windows-latest]
-        dotnet: [6.0.203]
+        dotnet: [6.0.302]
     runs-on: ${{ matrix.os }}
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Setup .NET Core
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: 6.0.203
-    - name: Restore tools
-      run: dotnet tool restore
-    - name: Restore projects
-      run: dotnet restore FSharp.Core\FSharp.Core.fsproj
-    - name: Checkout fsharp master
-      run: git clone https://github.com/dotnet/fsharp --depth 1 fsharp -b main
-    - name: Build fsharp master (turn of CI build status)
-      run: cd fsharp && eng\CIBuild.cmd
-    - name: Checkout FSharp.Formatting master
-      run: git clone https://github.com/fsprojects/FSharp.Formatting --depth 1 FSharp.Formatting 
-    - name: Build FSharp.Formatting master
-      run: cd FSharp.Formatting && .\build -t Build
-    - name: Run fsdocs
-      run: dotnet FSharp.Formatting\src\fsdocs-tool\bin\Release\net6.0\fsdocs.dll build --sourcefolder fsharp
-    - name: Deploy
-      uses: peaceiris/actions-gh-pages@v3
-      with:
-        personal_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./output
-        publish_branch: gh-pages
-        force_orphan: true
+      - uses: actions/checkout@v3
+      - name: Setup .NET Core
+        uses: actions/setup-dotnet@v2
+        with:
+          dotnet-version: 6.0.302
+      - name: Restore tools
+        run: dotnet tool restore
+      - name: Restore projects
+        run: dotnet restore FSharp.Core\FSharp.Core.fsproj
+      - name: Checkout fsharp master
+        run: git clone https://github.com/dotnet/fsharp --depth 1 fsharp -b main
+      - name: Build fsharp master (turn of CI build status)
+        run: cd fsharp && eng\CIBuild.cmd
+      - name: Checkout FSharp.Formatting master
+        run: git clone https://github.com/fsprojects/FSharp.Formatting --depth 1 FSharp.Formatting
+      - name: Build FSharp.Formatting master
+        run: cd FSharp.Formatting && .\build -t Build
+      - name: Run fsdocs
+        run: dotnet FSharp.Formatting\src\fsdocs-tool\bin\Release\net6.0\fsdocs.dll build --sourcefolder fsharp
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          personal_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./output
+          publish_branch: gh-pages
+          force_orphan: true

.github/workflows/pr.yml

@@ -3,34 +3,33 @@ name: Pull request checks
 on:
   pull_request:
     branches:
-      - '**'
+      - "**"
 
 jobs:
   build:
-
     strategy:
       matrix:
         os: [windows-latest]
-        dotnet: [6.0.203]
+        dotnet: [6.0.302]
     runs-on: ${{ matrix.os }}
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Setup .NET Core
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: 6.0.203
-    - name: Restore tools
-      run: dotnet tool restore
-    - name: Restore projects
-      run: dotnet restore FSharp.Core\FSharp.Core.fsproj
-    - name: Checkout fsharp master
-      run: git clone https://github.com/dotnet/fsharp --depth 1 fsharp -b main
-    - name: Build fsharp master (turn of CI build status)
-      run: cd fsharp && eng\CIBuild.cmd
-    - name: Checkout FSharp.Formatting master
-      run: git clone https://github.com/fsprojects/FSharp.Formatting --depth 1 FSharp.Formatting 
-    - name: Build FSharp.Formatting master
-      run: cd FSharp.Formatting && .\build -t Build
-    - name: Run fsdocs
-      run: dotnet FSharp.Formatting\src\fsdocs-tool\bin\Release\net5.0\fsdocs.dll build --sourcefolder fsharp
+      - uses: actions/checkout@v3
+      - name: Setup .NET Core
+        uses: actions/setup-dotnet@v2
+        with:
+          dotnet-version: 6.0.302
+      - name: Restore tools
+        run: dotnet tool restore
+      - name: Restore projects
+        run: dotnet restore FSharp.Core\FSharp.Core.fsproj
+      - name: Checkout fsharp master
+        run: git clone https://github.com/dotnet/fsharp --depth 1 fsharp -b main
+      - name: Build fsharp master (turn of CI build status)
+        run: cd fsharp && eng\CIBuild.cmd
+      - name: Checkout FSharp.Formatting master
+        run: git clone https://github.com/fsprojects/FSharp.Formatting --depth 1 FSharp.Formatting
+      - name: Build FSharp.Formatting master
+        run: cd FSharp.Formatting && .\build -t Build
+      - name: Run fsdocs
+        run: dotnet FSharp.Formatting\src\fsdocs-tool\bin\Release\net5.0\fsdocs.dll build --sourcefolder fsharp

CODE_OF_CONDUCT.md

@@ -68,9 +68,9 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+<https://www.contributor-covenant.org/faq>

README.md

@@ -1,31 +1,31 @@
 # FSharp.Core API documentation generation
 
-https://fsharp.github.io/fsharp-core-docs
+<https://fsharp.github.io/fsharp-core-docs>
 
 ## Contributing to Library Content
 
 To improve the content of the F# Core library documentation, contribute to the XML `///` documentation in the
 signature files (`*.fsi`) in the FSharp.Core implementation.
 
-* Fork and clone https://github.com/dotnet/fsharp locally, see below, as a subdirectory of your copy of `fsharp-core-docs`
+* Fork and clone <https://github.com/dotnet/fsharp> locally, see below, as a subdirectory of your copy of `fsharp-core-docs`
 
-* Contribute to [the FSharp.Core directory ](https://github.com/dotnet/fsharp/tree/master/src/fsharp/FSharp.Core)
+* Contribute to [the FSharp.Core directory](https://github.com/dotnet/fsharp/tree/master/src/fsharp/FSharp.Core)
 
 * Use a local build, see below
 
-* Submit work to  `main` branch of https://github.com/dotnet/fsharp
+* Submit work to  `main` branch of <https://github.com/dotnet/fsharp>
 
 * Once accepted your work will be published through a rebuild here. Site rebuilds daily at 17:30 UTC, or submit a dummy pull request here to trigger.
 
 ## Contributing to Generation of API Docs
 
 The docs are generated by using `fsdocs` tool from FSharp.Formatting.  If you want to improve the generation process:
 
-* Contribute to the API Docs mode and/or HTML generator in [FSharp.Formatting.ApiDocs](https://github.com/fsprojects/FSharp.Formatting/tree/master/src/FSharp.Formatting.ApiDocs) and [the `fsdocs` tool](https://github.com/fsprojects/FSharp.Formatting/tree/master/src/FSharp.Formatting.CommandTool) 
+* Contribute to the API Docs mode and/or HTML generator in [FSharp.Formatting.ApiDocs](https://github.com/fsprojects/FSharp.Formatting/tree/master/src/FSharp.Formatting.ApiDocs) and [the `fsdocs` tool](https://github.com/fsprojects/FSharp.Formatting/tree/master/src/FSharp.Formatting.CommandTool)
 
 * Use a local copy of these, see below, as a subdirectory of fsharp-core-docs
 
-* Submit work to the `master` branch of https://github.com/fsprojects/FSharp.Formatting
+* Submit work to the `master` branch of <https://github.com/fsprojects/FSharp.Formatting>
 
 * Once accepted the new tooling will be published through a rebuild here, so submit a dummy pull request here that increments dummyVersion.txt
 
@@ -44,7 +44,6 @@ This template is *not* the long term plan (unless it is improved enough).  We ca
 
 Whatever improvements you make should eventually get copied across back into FSharp.Formatting (and the duplicated template and styling will then likely be removed from this repo once it's no longer needed). If the design diverges to be a completely different look and feel then we can make several templates available in FSharp.Formatting with this as one of them.
 
-
 ## Build steps
 
 Eventually the build will just be
@@ -71,7 +70,7 @@ For now, we want to pick up the latest copies of FSharp.Formatting and FSharp.Co
     pushd FSharp.Formatting
     .\build -t Build
     popd
-    
+
 Then do iterative development using:
 
     (from 'fsharp-core-docs')
@@ -88,5 +87,3 @@ To build the very latest and freshest docs using the latest `fsdocs` tooling the
 2. builds `FSharp.Formatting` master branch
 
 3. Uses that `FSharp.Formatting` tool to build the docs for the FSharp.Core built in step 1
-
-

docs/index.md

@@ -20,9 +20,9 @@ The following namespaces are available:
 
 * [FSharp.Reflection](reference/fsharp-reflection.html) - Library functionality for accessing additional information about F# types and F# values at runtime, augmenting that available through [System.Reflection](https://docs.microsoft.com/dotnet/api/system.reflection). See also [F# Reflection](https://en.wikibooks.org/wiki/F_Sharp_Programming/Reflection) in the F# Wiki Book.  
 
-* [FSharp.NativeInterop](reference/fsharp-nativeinterop.html) - Basic functionality for native interopability. See also [F# External Functions](https://docs.microsoft.com/en-us/dotnet/fsharp/language-reference/functions/external-functions) in the F# Language Guide. 
+* [FSharp.NativeInterop](reference/fsharp-nativeinterop.html) - Basic functionality for native interopability. See also [F# External Functions](https://docs.microsoft.com/en-us/dotnet/fsharp/language-reference/functions/external-functions) in the F# Language Guide.
 
-* [FSharp.Core.CompilerServices](reference/fsharp-core-compilerservices.html) - Library functionality for supporting type providers and code generated by the F# compiler. See also [F# Type Providers](https://docs.microsoft.com/en-us/dotnet/fsharp/tutorials/type-providers/) in the F# Language Guide. 
+* [FSharp.Core.CompilerServices](reference/fsharp-core-compilerservices.html) - Library functionality for supporting type providers and code generated by the F# compiler. See also [F# Type Providers](https://docs.microsoft.com/en-us/dotnet/fsharp/tutorials/type-providers/) in the F# Language Guide.
 
 ## Contributing to this documentation