search

fsharp / fsharp-core-docs

Generated API documentation for the FSharp.Core library. Generated using FSharp.Formatting.
http://fsharp.github.io/fsharp-core-docs
MIT License
34 stars 19 forks source link

Add info about making dummy PRs. #68

Closed MaxWilson closed 3 years ago

MaxWilson commented 3 years ago

The readme says "Once accepted your work will be published through a rebuild here, so submit a dummy pull request here".

This is a dummy PR for the sake of recently-added Options API documentation (usage examples).

If this dummy PR is not needed to trigger a rebuild, please ignore.

dsyme commented 3 years ago

It is needed, thanks

This line should pick things up from dotnet/fsharp main, all going as planned https://github.com/fsharp/fsharp-core-docs/blob/master/.github/workflows/docs.yml#L29

dsyme commented 3 years ago

@MaxWilson Please report here whether results are as hoped after the github action finishes

dsyme commented 3 years ago

Action is here: https://github.com/fsharp/fsharp-core-docs/actions/runs/572198701

dsyme commented 3 years ago

@MaxWilson Would you like to become co-maintainer on this, so you can trigger at will? I'd be happy to have that

MaxWilson commented 3 years ago

@dsyme sure, I am planning to add documentation for more of the API so that would help.

The results at https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-optionmodule.html look as I was hoping they would. Success!

dsyme commented 3 years ago

@MaxWilson Invitation sent!