Home

docs.fsharp.org plan-of-attack

Proposal

Assuming we use FSDocs + Markdown files to generate the entire site. Do we need to discuss possibly using Jekyll or Hugo in conjunction with FSDocs?

Hugo allows you to use remote sources for content. Perhaps that way the various documentation could remain in the repos they are in now, rather than migrating into this repo. This repo would just be a Hugo site + build scripts etc.

Another idea is that the content discussed below could go into fsharp.org/docs rather than docs.fsharp.org. Is that an idea we want to pursue?

Tasks

• Setup FSDocs Github action, based on fsharp-core-docs Should publish output folder.
• Include F# Library Reference -- Generated API docs. currently here
• Include (convert?) Spec non-markdown content -- currently here
• Include F# Language Spec markdown docs -- currently here
• Include F# Compiler Docs -- This also generates API docs. currently here
• Modify old site(s) to 301 redirect page requests to the new docs.fsharp.org
• Design site navigation to include new content
• Implement search -- I think FSDocs will only index the generated API docs (i.e. the Library Reference). Another option could be to get an Algoria open source / non-profit license.
• There are a few links to the current site on learn.microsoft.com. Submit a PR to update these.
• Improve styling / CSS. Perhaps HTMX boost the site as I did with fsharp.org?