search

SaturnFramework / Saturn

Opinionated, web development framework for F# which implements the server-side, functional MVC pattern
https://saturnframework.org
MIT License
703 stars 108 forks source link

[WIP] Fix the docs generation script #357

Closed 64J0 closed 1 year ago

64J0 commented 1 year ago

Description:

With this PR my goal is to fix the docs generation script.

Apparently there were some big changes in packages used in this process, and this script was not updated so far.

[WIP] How to test it?

dotnet tool restore

# don't know yet if this is necessary
# but I run it before the other commands
dotnet run -- Docs

cd docs/
dotnet fornax build
cartermp commented 1 year ago

I moved back to .NET 6 for the action: https://github.com/SaturnFramework/Saturn/blob/main/.github/workflows/docs.yml#L19

Any concerns with merging and iterating from there?

64J0 commented 1 year ago

Ack, I'll keep working considering the .NET 6 SDK. I'm actually using the version 6.0.200 as well.

64J0 commented 1 year ago

@baronfel @cartermp Do you know if we have some docs related to this documentation generation?

I'm having some trouble understanding that code. And apparently, there were a bunch of major updates (at least in the FSharp.Formatting library), so some types are broken and I'll need to fix them.

cartermp commented 1 year ago

@64J0 unfortunately no, I don't know much about this particular docs tool. As for FSharp.Formatting, yes, it's undergone an incredible amount of breaking changes as well. I almost wonder if it's easier to just start entirely from scratch.

64J0 commented 1 year ago

FsLabOrg uses a similar strategy to build the docs with Fornax. And it's working AFAIK. Later I'll try to replicate its configuration here, at least for the build docs job.

64J0 commented 1 year ago

Since I'm not going to keep working in this PR for a while, I decided to close it. In the future, if it's still required, I can get back when having free time.