-
Notifications
You must be signed in to change notification settings - Fork 803
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add additional release note entries.
- Loading branch information
Showing
4 changed files
with
61 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,9 @@ | ||
### Added | ||
|
||
* Better generic unmanaged structs handling. ([Language suggestion #692](https://github.com/fsharp/fslang-suggestions/issues/692), [PR #12154](https://github.com/dotnet/fsharp/pull/12154)) | ||
* Bidirectional F#/C# interop for 'unmanaged' constraint. ([PR #12154](https://github.com/dotnet/fsharp/pull/12154)) | ||
* Bidirectional F#/C# interop for 'unmanaged' constraint. ([PR #12154](https://github.com/dotnet/fsharp/pull/12154)) | ||
* Make `.Is*` discriminated union properties visible. ([Language suggestion #222](https://github.com/fsharp/fslang-suggestions/issues/222), [PR #16341](https://github.com/dotnet/fsharp/pull/16341)) | ||
|
||
### Fixed | ||
|
||
* Allow extension methods without type attribute work for types from imported assemblies. ([PR #16368](https://github.com/dotnet/fsharp/pull/16368)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
title: Running the documentation locally | ||
category: Compiler Internals | ||
categoryindex: 200 | ||
index: 999 | ||
--- | ||
# Running the documentation locally | ||
|
||
The source of this documentation website is hosted on https://github.com/fsharp/fsharp-compiler-docs. | ||
You can follow this guide to see the results of your document changes rendered in the browser. | ||
|
||
## Setup | ||
|
||
`fsharp/fsharp-compiler-docs` will clone the `dotnet/fsharp` repository first to generate the documentation. | ||
You can however, easily run the documentation locally and modify the `docs` from `dotnet/fsharp`. | ||
|
||
* Clone `fsharp/fsharp-compiler-docs` at the same level as your local `dotnet/fsharp` repository: | ||
|
||
|
||
git clone https://github.com/fsharp/fsharp-compiler-docs.git | ||
|
||
|
||
* Restore the `FSharp.Compiler.Service` project in `fsharp-compiler-docs`: | ||
|
||
|
||
cd fsharp-compiler-docs/FSharp.Compiler.Service | ||
dotnet restore | ||
|
||
|
||
* Restore the local tools in `fsharp-compiler-docs`: | ||
|
||
|
||
cd .. | ||
dotnet tool restore | ||
|
||
|
||
* Run the documentation tool using your `dotnet/fsharp` fork as input. | ||
|
||
|
||
dotnet fsdocs watch --eval --sourcefolder ../fsharp/ --input ../fsharp/docs/ | ||
|
||
|
||
## Release notes caveat | ||
|
||
The release notes pages from `docs/release-notes` are composed from the MarkDown files in subfolders. | ||
Changing any of these files, won't regenerate the served webpage. Only the changes to the `.fsx` will trigger the tool. This is a known limitation. |