You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-10
Original file line number
Diff line number
Diff line change
@@ -1,31 +1,31 @@
1
1
# FSharp.Core API documentation generation
2
2
3
-
https://fsharp.github.io/fsharp-core-docs
3
+
<https://fsharp.github.io/fsharp-core-docs>
4
4
5
5
## Contributing to Library Content
6
6
7
7
To improve the content of the F# Core library documentation, contribute to the XML `///` documentation in the
8
8
signature files (`*.fsi`) in the FSharp.Core implementation.
9
9
10
-
* Fork and clone https://github.com/dotnet/fsharp locally, see below, as a subdirectory of your copy of `fsharp-core-docs`
10
+
* Fork and clone <https://github.com/dotnet/fsharp> locally, see below, as a subdirectory of your copy of `fsharp-core-docs`
11
11
12
-
* Contribute to [the FSharp.Core directory](https://github.com/dotnet/fsharp/tree/master/src/fsharp/FSharp.Core)
12
+
* Contribute to [the FSharp.Core directory](https://github.com/dotnet/fsharp/tree/master/src/fsharp/FSharp.Core)
13
13
14
14
* Use a local build, see below
15
15
16
-
* Submit work to `main` branch of https://github.com/dotnet/fsharp
16
+
* Submit work to `main` branch of <https://github.com/dotnet/fsharp>
17
17
18
18
* 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.
19
19
20
20
## Contributing to Generation of API Docs
21
21
22
22
The docs are generated by using `fsdocs` tool from FSharp.Formatting. If you want to improve the generation process:
23
23
24
-
* 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)
24
+
* 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)
25
25
26
26
* Use a local copy of these, see below, as a subdirectory of fsharp-core-docs
27
27
28
-
* Submit work to the `master` branch of https://github.com/fsprojects/FSharp.Formatting
28
+
* Submit work to the `master` branch of <https://github.com/fsprojects/FSharp.Formatting>
29
29
30
30
* Once accepted the new tooling will be published through a rebuild here, so submit a dummy pull request here that increments dummyVersion.txt
31
31
@@ -44,7 +44,6 @@ This template is *not* the long term plan (unless it is improved enough). We ca
44
44
45
45
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.
46
46
47
-
48
47
## Build steps
49
48
50
49
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
71
70
pushd FSharp.Formatting
72
71
.\build -t Build
73
72
popd
74
-
73
+
75
74
Then do iterative development using:
76
75
77
76
(from 'fsharp-core-docs')
@@ -88,5 +87,3 @@ To build the very latest and freshest docs using the latest `fsdocs` tooling the
88
87
2. builds `FSharp.Formatting` master branch
89
88
90
89
3. Uses that `FSharp.Formatting` tool to build the docs for the FSharp.Core built in step 1
Copy file name to clipboardExpand all lines: docs/index.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -20,9 +20,9 @@ The following namespaces are available:
20
20
21
21
*[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.
22
22
23
-
*[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.
23
+
*[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.
24
24
25
-
*[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.
25
+
*[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.
0 commit comments