fix(nxdoc): include generator / executor description in detail file

nx-dotnet · May 23, 2021 · b0bf601 · b0bf601
1 parent ab15a41
commit b0bf601
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 0 deletions.
diff --git a/docs/core/executors/build.md b/docs/core/executors/build.md
@@ -2,6 +2,8 @@
 
 ## NxDotnet Build
 
+Builds an app via the `dotnet` cli command.
+
 ## Options
 
 ### framework (string)

diff --git a/docs/core/executors/format.md b/docs/core/executors/format.md
@@ -2,6 +2,8 @@
 
 ## Format executor
 
+Formats and lints a project using the dotnet-format tool
+
 ## Options
 
 ### noRestore (boolean)

diff --git a/docs/core/executors/publish.md b/docs/core/executors/publish.md
@@ -2,6 +2,8 @@
 
 ## NxDotnet Publish
 
+Publishes an app via the `dotnet` cli command.
+
 ## Options
 
 ### configuration (string)

diff --git a/docs/core/executors/serve.md b/docs/core/executors/serve.md
@@ -2,6 +2,8 @@
 
 ## NxDotnet Serve Executor
 
+Uses `dotnet run` and chokidar to run a .NET app.
+
 ## Options
 
 ### configuration (string)

diff --git a/docs/core/generators/app.md b/docs/core/generators/app.md
@@ -2,6 +2,8 @@
 
 ## NxDotnet Application Generator
 
+Generate a dotnet project under the application directory.
+
 ## Options
 
 ### name (string)

diff --git a/docs/core/generators/init.md b/docs/core/generators/init.md
@@ -1,3 +1,5 @@
 # @nx-dotnet/core:init
 
 ## Initialize NxDotnet
+
+Update&#39;s user&#39;s gitignore file + initializes a blank config
diff --git a/docs/core/generators/lib.md b/docs/core/generators/lib.md
@@ -2,6 +2,8 @@
 
 ## NxDotnet Library Generator
 
+Generate a dotnet project under the library directory.
+
 ## Options
 
 ### name (string)

diff --git a/docs/core/generators/nuget-reference.md b/docs/core/generators/nuget-reference.md
@@ -2,6 +2,8 @@
 
 ## Nuget Reference
 
+Add a nuget reference to a .NET project
+
 ## Options
 
 ### project (string)

diff --git a/docs/core/generators/project-reference.md b/docs/core/generators/project-reference.md
@@ -2,6 +2,8 @@
 
 ## Project Reference Generator
 
+Adds a project reference to the host project that points to the source project.
+
 ## Options
 
 ### project (string)

diff --git a/docs/core/generators/restore.md b/docs/core/generators/restore.md
@@ -1,3 +1,5 @@
 # @nx-dotnet/core:restore
 
 ## Restore Generator
+
+Restores NuGet packages and .NET tools used by the workspace.
diff --git a/docs/core/generators/sync.md b/docs/core/generators/sync.md
@@ -1,3 +1,5 @@
 # @nx-dotnet/core:sync
 
 ## Sync Generator
+
+Syncs package versions across the workspace with nx-dotnet config.
diff --git a/...es/nxdoc/src/generators/generate-docs/templates/detail/__generatorFileName__.md b/...es/nxdoc/src/generators/generate-docs/templates/detail/__generatorFileName__.md
@@ -4,6 +4,8 @@
 
 ## <%= schema.title %><%}%>
 
+<%=schema.description%>
+
 <% if(Object.values(schema.properties).length > 0) {%>
 
 ## Options <% Object.entries(schema.properties).forEach(([property, config]) => {%>