Skip to content

Commit

Permalink
Adjust docs to post-paket era (#2607)
Browse files Browse the repository at this point in the history
* Now that paket is gone, adjust the Ionide.KeepAChangelog Visual Studio issue.

* Adjust documentation about our way to get the compiler sources.
  • Loading branch information
dawedawe authored Nov 4, 2022
1 parent 767620c commit 1e52026
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/docs/contributors/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ Or if something isn't all that clear. Our goal is to make this documentation as

There is currently [a known issue](https://github.com/fsprojects/fantomas/issues/2447) when loading the `fantomas` solution in Visual Studio that prevents the solution from being able to build properly. This is due to an issue in the `Ionide.KeepAChangelog` build step (tracking the issue [here](https://github.com/ionide/KeepAChangelog/issues/8)).

To workaround this in the meantime, you'll need to comment out the references to `Ionide.KeepAChangelog.Tasks` in `paket.dependencies` and all of the `paket.references` files, and then run `dotnet paket install` again. **Please be careful not to include these changes when submitting a PR!**
To workaround this in the meantime, you'll need to comment out the references to `Ionide.KeepAChangelog.Tasks` in `Directory.Build.props` and all of the `packages.lock.json` files, and then run `dotnet restore`. **Please be careful not to include these changes when submitting a PR!**

<fantomas-nav next="./FSharp.html"></fantomas-nav>
2 changes: 1 addition & 1 deletion docs/docs/contributors/Solution Structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ graph TD
## Fantomas.FCS

This is a very custom fork of the F# compiler. We only expose a single parse function to construct the untyped syntax tree.
We achieve this by taking the files necessary to compile the F# parser from source (via `paket`).
We achieve this by taking the files necessary to compile the F# parser from source (via custom code in a `Fun.Build` pipeline).
This limits the dependency footprint that our compiler has, compared to the official [F# compiler NuGet package](https://www.nuget.org/packages/FSharp.Compiler.Service).

Note that the AST returned by `Fantomas.FCS` looks identical to what the official F# compiler returns.
Expand Down

0 comments on commit 1e52026

Please sign in to comment.