-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
F#5 for Docs -- One Approach #102
Conversation
- Latest version of fsformatting - .NET 5.0 - Doc properties in build props - Temporarily remove old doc tooling from sln
Looks like we get some issues with rendering docs that use F# Data types. |
What's the status on this PR? I'd like to build on top of this to address #103 (specifically to show how to write a combined I'm happy to get help with this PR if others are too busy as I have some time over the next few days. |
@Choc13 I've done some work in:
in order to publish to: There are some things that needs to be adjusted, perhaps fixed in F# Formatting. We notice that we get a lot of unfiltered types: What we would like would be to be able to filter out types from rendering in the documentation. There is this issue related to the rendering: |
It also looks like the icon does not render in the reference docs. |
That some of the types gets repeated could perhaps be OK enough, we could add some xml-doc texts writing that they are internal. The icon not showing looks a bit more annoying, so would be nice to fix. |
This updates to F#5 for documentation. Along the way, it updates the FSFormatting tool rather considerable (from version 4 to 8). To try and make the documentation build as "standard" as possible, I've experimented with moving documentation out of
docsrc
and in todocs/
, wherefsdocs
looks for them by default. This can be tested locally by pulling down my branch and running:This makes writing and previewing docs very simple and lightweight. However, it does not solve the question of deploy automation -- which can be solved so many ways that I wanted to check in with y'all about preferences. There's also some question about project structure. I'm inclined towards:
docsrc
dir; renamedocs
todocsrc
.fsdocs
to build fromdocsrc
, outputting todocs/
docs
dir.For automation, this could be: a shell script; a FAKE script; an F# script mostly replicating some of the tooling currently in
docsrc
; an update to the currentdocsrc
program. I'm happy to be guided by y'all. I typically default to FAKE, because I find it to be the "least surprising" thing -- but not everyone loves FAKE.Thanks in advance!