Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a206443

Browse files
dsymedsyme
committed
use doc content from dotnet/fsharp
1 parent 21ce8ee commit a206443

File tree

6 files changed

+9
-53
lines changed

6 files changed

+9
-53
lines changed

‎.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
- name: Build fsharp master (turn of CI build status)
3131
run: cd fsharp && eng\CIBuild.cmd
3232
- name: Run fsdocs
33-
run: dotnet fsdocs build --sourcefolder fsharp
33+
run: dotnet fsdocs build --sourcefolder fsharp --input fsharp/docs/fcs
3434
- name: Deploy
3535
uses: peaceiris/actions-gh-pages@v3
3636
with:

‎.github/workflows/pr.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ jobs:
2929
- name: Build fsharp master (turn of CI build status)
3030
run: cd fsharp && eng\CIBuild.cmd
3131
- name: Run fsdocs
32-
run: dotnet fsdocs build --sourcefolder fsharp
32+
run: dotnet fsdocs build --sourcefolder fsharp --input fsharp/docs/fcs

‎README.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,9 @@ https://fsharp.github.io/FSharp.Compiler.Service
77
To improve the content of the FSharp.Compiler.Service library documentation, contribute to the XML `///` documentation in the
88
signature files (`*.fsi`) in the FSharp.Compiler.Service implementation.
99

10-
* Fork and clone https://github.com/dotnet/fsharp locally, see below, as a subdirectory of your copy of `FSharp.Compiler.Service`
10+
* Fork and clone https://github.com/dotnet/fsharp locally, see below
1111

12-
* Contribute to [the src/fsharp directory](https://github.com/dotnet/fsharp/tree/master/src/fsharp)
13-
14-
* Use a local build, see below
15-
16-
* Submit work to `main` branch of https://github.com/dotnet/fsharp
12+
* Contribute to [the src/fsharp directory](https://github.com/dotnet/fsharp/tree/master/src/fsharp) and submit work to `main` branch of https://github.com/dotnet/fsharp
1713

1814
* Once accepted your work will be published through a rebuild here, so submit a dummy pull request here
1915

@@ -25,7 +21,7 @@ The docs are generated by using `fsdocs` tool from FSharp.Formatting. If you wa
2521

2622
* Use a local copy of these, see below, as a subdirectory of FSharp.Compiler.Service
2723

28-
* Submit work to the `master` branch of https://github.com/fsprojects/FSharp.Formatting
24+
* Submit work to https://github.com/fsprojects/FSharp.Formatting
2925

3026
* Once accepted the new tooling will be published through a rebuild here, so submit a dummy pull request here that increments dummyVersion.txt
3127

@@ -44,7 +40,6 @@ This template is *not* the long term plan (unless it is improved enough). We ca
4440

4541
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.
4642

47-
4843
## Build steps
4944

5045
Eventually the build will just be
@@ -53,29 +48,23 @@ Eventually the build will just be
5348
dotnet restore FSharp.Compiler.Service
5449
dotnet fsdocs build
5550

56-
For now, we want to pick up the latest copies of FSharp.Formatting and FSharp.Compiler.Service, and set you up to make contributions to these. So we ask you to clone local copies of these:
51+
For now, we make a fresh build of FSharp.Compiler.Service.
5752

5853
(start in 'FSharp.Compiler.Service')
5954
dotnet restore FSharp.Compiler.Service
6055

61-
(make 'FSharp.Compiler.Service/fsharp' and 'FSharp.Compiler.Service/FSharp.Formatting' )
56+
(make 'FSharp.Compiler.Service/fsharp')
6257
git clone https://github.com/dotnet/fsharp --depth 1 -b main
63-
git clone https://github.com/fsprojects/FSharp.Formatting --depth 1
6458

6559
(build 'FSharp.Compiler.Service/fsharp')
6660
pushd fsharp
6761
.\build -noVisualStudio
6862
popd
6963

70-
(build 'FSharp.Compiler.Service/FSharp.Formatting')
71-
pushd FSharp.Formatting
72-
.\build -t Build
73-
popd
74-
7564
Then do iterative development using:
7665

7766
(from 'FSharp.Compiler.Service')
78-
FSharp.Formatting\src\FSharp.Formatting.CommandTool\bin\Release\netcoreapp3.1\fsdocs.exe watch --sourcefolder fsharp
67+
dotnet fsdocs watch --sourcefolder fsharp --input fsharp/docs/fcs
7968

8069
## CI Pipeline
8170

@@ -85,8 +74,4 @@ To build the very latest and freshest docs using the latest `fsdocs` tooling the
8574

8675
1. build dotnet/fsharp `main` branch (where we assume latest doc updates have been pushed)
8776

88-
2. builds `FSharp.Formatting` master branch
89-
90-
3. Uses that `FSharp.Formatting` tool to build the docs for the FSharp.Compiler.Service built in step 1
91-
92-
77+
2. Uses the `fsdocs` tool to build the docs for the FSharp.Compiler.Service built in step 1

‎docs/img/favicon.ico

-14.7 KB
Binary file not shown.

‎docs/img/logo.png

-3.25 KB
Binary file not shown.

‎docs/index.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)