Skip to content

Commit 6108d05

Browse files
docs: address PR #318 review comments (#325)
## Summary - Add NuGet explanation (external libraries) for non-.NET developers - Clarify publish output location and benefits of single-file deployment - Remove misleading info metadata example that implied required fields Addresses review comments 2, 3, 4, and 5 from PR #318.
1 parent 01cd0dc commit 6108d05

File tree

5 files changed

+3
-18
lines changed

5 files changed

+3
-18
lines changed

docfx_project/docs/building-and-running.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Your connector is a console application with a simple entry point in [Program.cs
1717

1818
### What Gets Built
1919

20-
When you run `dotnet build`, the compiler compiles all `.cs` files, resolves NuGet dependencies, and produces an executable with a `.dll` (your code) and `.exe` (launcher) in `bin/Debug/<target-framework>/` or `bin/Release/<target-framework>/`.
20+
When you run `dotnet build`, the compiler compiles all `.cs` files, resolves NuGet dependencies (external libraries), and produces an executable with a `.dll` (your code) and `.exe` (launcher) in `bin/Debug/<target-framework>/` or `bin/Release/<target-framework>/`.
2121

2222
## Building & Running Your Connector
2323

@@ -55,7 +55,7 @@ dotnet publish -r win-x64 -c Release \
5555
/p:EnableCompressionInSingleFile=true
5656
```
5757

58-
This produces a single file binary with everything needed to run in the `bin/Release/<target-framework>/win-x64/publish/`
58+
This produces a single file binary with everything needed to run in the `bin/Release/<target-framework>/win-x64/publish/`. This makes it easier to share your connector with others, as a single file packages everything needed to run the connector on another environment.
5959

6060
## Running as a Windows Service
6161

docfx_project/docs/create-connector.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -260,8 +260,6 @@ public class NewSimClient : AutomationClient, ISimulatorClient<DefaultModelFiles
260260
Initialize();
261261
workbook = OpenBook(modelState.FilePath);
262262
263-
// var routine = new NewSimRoutine(workbook, routineRev, inputData, logger);
264-
// return routine.PerformSimulation(token);
265263
return null;
266264
}
267265
finally

docfx_project/docs/implement-routine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -480,4 +480,4 @@ public override void SetInput(
480480
481481
---
482482

483-
**Next:** Continue to [Testing](testing.md) to learn how to test your connector.
483+
**Next:** Continue to [Testing](testing-and-extras.md) to learn how to test your connector.

docfx_project/docs/model-parsing.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -108,19 +108,6 @@ The DWSIM implementation shows how to:
108108

109109
You can also optionally extract arbitrary metadata about the model using the `info` field. This is a key-value structure that can hold any JSON-serializable data.
110110

111-
### Info Structure
112-
113-
```csharp
114-
var info = new Dictionary<string, string>
115-
{
116-
["ModelVersion"] = "2.1",
117-
["CreatedDate"] = "2024-01-15",
118-
["Author"] = "John Doe",
119-
["Description"] = "Distillation column model",
120-
["CustomField"] = "Custom value"
121-
};
122-
```
123-
124111
### When to Use Info
125112

126113
Use `info` for:
372 Bytes
Loading

0 commit comments

Comments
 (0)