ProjectScaffold
ProjectScaffold copied to clipboard
Project Structure page does not fully reflect what is generated
Description
I am pretty new to F# and the whole F# ecosystem and so don't know much about what most of the folders do, so I went to the Project Structure page which is currently located here and has it's source here. The list of folders here has a few discrepancies with what I got when I first cloned and ran the build.
- The page refers to
docs
as the place where to find the.fsx
and.md
files, however they seem to be in a folder calleddocsrc
. This is confusing because there is also adocs
folder which seems to be the auto-generated output, but then I seedocs/output
in the current structure page with a comment saying to "not commit this directory to source control". - No mention of what the
.fake
directory is for - The page currently mentions a
nuget
directory, but I do not see any auto-generated - No mention of what
paket-files
directory is for - Mentions a
temp
directory which doesn't seem to exist, even after running the build script again - A bunch of other files in the root directory are not explained which I feel are F#/ProjectScaffold specific such as
build.fsx
,packet.dependencies
,packet.lock
,TestResults.xml
Repro steps
Please provide the steps required to reproduce the problem
-
Walk through the installation steps as per the Getting Started page
-
Compare the generated project structure against the Project Structure page
Expected behavior
The project structure wiki page should be up to date with what is currently generated
Actual behavior
The project structure wiki page seems to be out of date and/or missing some parts as described in the description of this issue.
Known workarounds
N/A
Related information
I ran ProjectScaffold
on Windows 10 from the master branch.