Skip to content

Commit 3fc9bf6

Browse files
committed
Fix all markdown files with markdown-lint
1 parent aa90c4f commit 3fc9bf6

File tree

3 files changed

+11
-14
lines changed

3 files changed

+11
-14
lines changed

CODE_OF_CONDUCT.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ members of the project's leadership.
6868
## Attribution
6969

7070
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
71+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
7272

7373
[homepage]: https://www.contributor-covenant.org
7474

7575
For answers to common questions about this code of conduct, see
76-
https://www.contributor-covenant.org/faq
76+
<https://www.contributor-covenant.org/faq>

README.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
# FSharp.Core API documentation generation
22

3-
https://fsharp.github.io/fsharp-core-docs
3+
<https://fsharp.github.io/fsharp-core-docs>
44

55
## Contributing to Library Content
66

77
To improve the content of the F# Core library documentation, contribute to the XML `///` documentation in the
88
signature files (`*.fsi`) in the FSharp.Core implementation.
99

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`
1111

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)
1313

1414
* Use a local build, see below
1515

16-
* Submit work to `main` branch of https://github.com/dotnet/fsharp
16+
* Submit work to `main` branch of <https://github.com/dotnet/fsharp>
1717

1818
* 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.
1919

2020
## Contributing to Generation of API Docs
2121

2222
The docs are generated by using `fsdocs` tool from FSharp.Formatting. If you want to improve the generation process:
2323

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)
2525

2626
* Use a local copy of these, see below, as a subdirectory of fsharp-core-docs
2727

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>
2929

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

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

4545
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.
4646

47-
4847
## Build steps
4948

5049
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
7170
pushd FSharp.Formatting
7271
.\build -t Build
7372
popd
74-
73+
7574
Then do iterative development using:
7675

7776
(from 'fsharp-core-docs')
@@ -88,5 +87,3 @@ To build the very latest and freshest docs using the latest `fsdocs` tooling the
8887
2. builds `FSharp.Formatting` master branch
8988

9089
3. Uses that `FSharp.Formatting` tool to build the docs for the FSharp.Core built in step 1
91-
92-

docs/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ The following namespaces are available:
2020

2121
* [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.
2222

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.
2424

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.
2626

2727
## Contributing to this documentation
2828

0 commit comments

Comments
 (0)