Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dsyme authored Nov 11, 2021
1 parent 234fad4 commit d323938
Showing 1 changed file with 7 additions and 36 deletions.
43 changes: 7 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,7 @@ signature files (`*.fsi`) in the FSharp.Compiler.Service implementation.

* Once accepted your work will be published through a rebuild here. A rebuild is triggered daily at 17:30 UTC or you can trigger it yourself by submitting a dummy change.

## Contributing to Generation of API Docs

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

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

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

* Submit work to https://github.com/fsprojects/FSharp.Formatting

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

## Contributing to Layout and Design

These pages are currently using [the default template of the FSharp.Formatting tools](https://github.com/fsprojects/FSharp.Formatting/blob/master/docs/_template.html)
with its small amount of corresponding [CSS and JavaScript](https://github.com/fsprojects/FSharp.Formatting/tree/master/docs/content)

See [FSharp.Formatting styling](https://fsprojects.github.io/FSharp.Formatting/styling.html) for information on styling for output generated by `fsdocs`.

This template is *not* the long term plan (unless it is improved enough). We can improve the design - please help with this.

1. Copy the default template and CSS to `docs`. Rebuild as before. This template will be used instead of the default template.

2. After you have identified fixes and improvements, contribute back to the default template of FSharp.Formatting, or submit your work here and we can assess that. This will help improve many F# libraries.

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.
The docs are generated by using `fsdocs` tool from FSharp.Formatting.

## Build steps

Expand All @@ -50,28 +25,24 @@ Eventually the build will just be

For now, we make a fresh build of FSharp.Compiler.Service.

(start in 'FSharp.Compiler.Service')
dotnet restore FSharp.Compiler.Service
(start in fsharp-conpiler-docs)
dotnet restore fsharp-conpiler-docs

(make 'FSharp.Compiler.Service/fsharp')
(make fsharp-conpiler-docs/fsharp)
git clone https://github.com/dotnet/fsharp --depth 1 -b main

(build 'FSharp.Compiler.Service/fsharp')
(build fsharp-conpiler-docs)
pushd fsharp
.\build -noVisualStudio
popd

Then do iterative development using:

(from 'FSharp.Compiler.Service')
(from fsharp-conpiler-docs)
dotnet fsdocs watch --sourcefolder fsharp --input fsharp/docs

## CI Pipeline

This repo is published via GitHub Actions. On each push to master, the docs are built, and the outputs (which are written to the `output` directory by fsdocs) are pushed to the `gh-pages` branch. This repo is configured to host using GitHub Pages from this branch, so once the generated files are pushed the update is nearly-instant.

To build the very latest and freshest docs using the latest `fsdocs` tooling the CI does this:
This repo is published via GitHub Actions. On each push to main, the docs are built, and the outputs (which are written to the `output` directory by fsdocs) are pushed to the `gh-pages` branch. This repo is configured to host using GitHub Pages from this branch.

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

2. Uses the `fsdocs` tool to build the docs for the FSharp.Compiler.Service built in step 1

0 comments on commit d323938

Please sign in to comment.