Skip to content
This repository has been archived by the owner on Feb 10, 2021. It is now read-only.

Documentation generator is properly broken #165

Closed
pblasucci opened this issue Oct 4, 2020 · 2 comments
Closed

Documentation generator is properly broken #165

pblasucci opened this issue Oct 4, 2020 · 2 comments

Comments

@pblasucci
Copy link
Contributor

It's ancient -- so hopefully not a surprise to anyone -- but at this point, the script to generate documentation is hopeless unusable.

Major issues:

  • FSharp.Formatting has a very different API
  • FSharp.Formatting no longer uses Razor
  • FSharpPowerTools no longer exists
  • The Paket, Fake integration is wrong
  • Nothing is setup to work on case-sensitive file systems

Suggested fixes (ideally all of these -- but at least 1 and 2):

  1. Upgrade FSharp.Formatting
  2. Rework templates to remove Razor
  3. Rework documentation folders to take advantage of fsdocs tool
  4. Eliminate Generate.fsx (this should just be part of build.fsx and should be a lot simpler if fsdocs tool is leveraged)
@pblasucci
Copy link
Contributor Author

Important: any work for this should be done on the fx-upgrade branch.

@pblasucci
Copy link
Contributor Author

Closing as part of archival process.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant