62 docs generation docs hotreload #149
Conversation
There was a problem hiding this comment.
This seems super-reasonable, and if you wanted to make the edit-templates-and-recompile cycle even better then you could even use fcswatch on the project. nice.
So a total-hotreload use case might be fcswatch <project> -- watch <glob>, right? To hotreload generation of the docs as you write them + hotreload restarting of your webserver when you change the templates?
Content/Library/docsTool/Program.fs
Outdated
| let parse (fileName : string) source = | ||
| let doc = | ||
| let fsharpCoreDir = sprintf "-I:%s" fsharpCoreDir | ||
| let runtimeDeps = "-r:System.Runtime -r:System.Net.WebClient" |
There was a problem hiding this comment.
For the set of dependencies to typecheck/run against, we may want to steal the logic from https://github.com/fsharp/FsAutoComplete/blob/master/src/FsAutoComplete.Core/FSIRefs.fs. This improves on the assembly-location logic from FCS (which fails per dotnet/fsharp#7701)
Yeah that was the intention, though I was just using |
|
Is this almost ready, and will it give a sample for .NET Core doc generation that I can copy into other repos? :-) |
|
Yeah this is pretty much good to go. There's a few things that I don't have working such as:
But these aren't what I'd consider show stoppers. |
|
I'm gonna go ahead and merge this back into the other branch now, then clean it up more there. |
Proposed Changes
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
Types of changes
What types of changes does your code introduce to MiniScaffold?
Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...