Merge pull request #69 from wieslawsoltes/docs/docfx-refresh

Docs

Author: wieslawsoltes

.config/dotnet-tools.json

@@ -0,0 +1,13 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "docfx": {
+      "version": "2.78.4",
+      "commands": [
+        "docfx"
+      ],
+      "rollForward": false
+    }
+  }
+}

.github/workflows/docs.yml

@@ -0,0 +1,38 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - master
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup .NET SDKs
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: |
+            10.0.x
+            8.0.x
+            6.0.x
+
+      - name: Restore local tools
+        run: dotnet tool restore
+
+      - name: Build docs
+        run: |
+          chmod +x build-docs.sh
+          ./build-docs.sh
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./_site

.gitignore

@@ -24,11 +24,14 @@ bld/
 [Oo]bj/
 [Ll]og/
 
-# Visual Studio 2015 cache/options directory
+# Visual Studio 2015/2017 cache/options directory
 .vs/
 # Uncomment if you have tasks that create the project's static files in wwwroot
 #wwwroot/
 
+# Visual Studio 2017 auto generated files
+Generated\ Files/
+
 # MSTest test Results
 [Tt]est[Rr]esult*/
 [Bb]uild[Ll]og.*
@@ -42,20 +45,29 @@ TestResult.xml
 [Rr]eleasePS/
 dlldata.c
 
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
 # .NET Core
 project.lock.json
 project.fragment.lock.json
 artifacts/
 **/Properties/launchSettings.json
 
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
 *_i.c
 *_p.c
 *_i.h
 *.ilk
 *.meta
 *.obj
+*.iobj
 *.pch
 *.pdb
+*.ipdb
 *.pgc
 *.pgd
 *.rsp
@@ -93,6 +105,9 @@ ipch/
 *.vspx
 *.sap
 
+# Visual Studio Trace Files
+*.e2e
+
 # TFS 2012 Local Workspace
 $tf/
 
@@ -113,6 +128,10 @@ _TeamCity*
 # DotCover is a Code Coverage Tool
 *.dotCover
 
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
+
 # Visual Studio code coverage results
 *.coverage
 *.coveragexml
@@ -148,7 +167,7 @@ publish/
 # Publish Web Output
 *.[Pp]ublish.xml
 *.azurePubxml
-# TODO: Comment the next line if you want to checkin your web deploy settings
+# Note: Comment the next line if you want to checkin your web deploy settings,
 # but database connection strings (with potential passwords) will be unencrypted
 *.pubxml
 *.publishproj
@@ -161,11 +180,11 @@ PublishScripts/
 # NuGet Packages
 *.nupkg
 # The packages folder can be ignored because of Package Restore
-**/packages/*
+**/[Pp]ackages/*
 # except build/, which is used as an MSBuild target.
-!**/packages/build/
+!**/[Pp]ackages/build/
 # Uncomment if necessary however generally it will be regenerated when needed
-#!**/packages/repositories.config
+#!**/[Pp]ackages/repositories.config
 # NuGet v3's project.json files produces more ignorable files
 *.nuget.props
 *.nuget.targets
@@ -183,6 +202,7 @@ AppPackages/
 BundleArtifacts/
 Package.StoreAssociation.xml
 _pkginfo.txt
+*.appx
 
 # Visual Studio cache files
 # files ending in .cache can be ignored
@@ -201,6 +221,10 @@ ClientBin/
 *.publishsettings
 orleans.codegen.cs
 
+# Including strong name files can present a security risk 
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+#*.snk
+
 # Since there are multiple workflows, uncomment next line to ignore bower_components
 # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
 #bower_components/
@@ -215,6 +239,8 @@ _UpgradeReport_Files/
 Backup*/
 UpgradeLog*.XML
 UpgradeLog*.htm
+ServiceFabricBackup/
+*.rptproj.bak
 
 # SQL Server files
 *.mdf
@@ -225,6 +251,7 @@ UpgradeLog*.htm
 *.rdl.data
 *.bim.layout
 *.bim_*.settings
+*.rptproj.rsuser
 
 # Microsoft Fakes
 FakesAssemblies/
@@ -236,9 +263,6 @@ FakesAssemblies/
 .ntvs_analysis.dat
 node_modules/
 
-# Typescript v1 declaration files
-typings/
-
 # Visual Studio 6 build log
 *.plg
 
@@ -275,9 +299,12 @@ __pycache__/
 *.pyc
 
 # Cake - Uncomment if you are using it
-tools/**
+# tools/**
 # !tools/packages.config
 
+# Tabs Studio
+*.tss
+
 # Telerik's JustMock configuration file
 *.jmconfig
 
@@ -287,5 +314,22 @@ tools/**
 *.odx.cs
 *.xsd.cs
 
-# macOS
-.DS_Store
+# OpenCover UI analysis results
+OpenCover/
+
+# Azure Stream Analytics local run output 
+ASALocalRun/
+
+# MSBuild Binary and Structured Log
+*.binlog
+
+# NVidia Nsight GPU debugger configuration file
+*.nvuser
+
+# MFractors (Xamarin productivity tool) working folder 
+.mfractor/
+
+# DocFX output
+/_site
+docfx/api/*.yml
+docfx/api/*.manifest

Directory.Build.props

@@ -7,9 +7,14 @@
     <Copyright>Copyright © Wiesław Šoltés 2026</Copyright>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/wieslawsoltes/NodeEditor</PackageProjectUrl>
+    <PackageIcon>Icon.png</PackageIcon>
   </PropertyGroup>
   <PropertyGroup>
     <AnalysisLevel>latest</AnalysisLevel>
     <LangVersion>latest</LangVersion>
   </PropertyGroup>
+
+  <ItemGroup>
+    <None Include="$(MSBuildThisFileDirectory)build/Assets/Icon.png" Pack="true" PackagePath="/" Visible="false" />
+  </ItemGroup>
 </Project>

README.md

@@ -3,8 +3,15 @@
 [![Build Status](https://dev.azure.com/wieslawsoltes/GitHub/_apis/build/status/wieslawsoltes.NodeEditor?branchName=main)](https://dev.azure.com/wieslawsoltes/GitHub/_build/latest?definitionId=104&branchName=main)
 [![CI](https://github.com/wieslawsoltes/NodeEditor/actions/workflows/build.yml/badge.svg)](https://github.com/wieslawsoltes/NodeEditor/actions/workflows/build.yml)
 
-[![NuGet](https://img.shields.io/nuget/v/NodeEditorAvalonia.svg)](https://www.nuget.org/packages/NodeEditorAvalonia)
-[![NuGet](https://img.shields.io/nuget/dt/NodeEditorAvalonia.svg)](https://www.nuget.org/packages/NodeEditorAvalonia)
+| Badge | Package | Downloads |
+| --- | --- | --- |
+| [![NuGet](https://img.shields.io/nuget/v/NodeEditorAvalonia.svg)](https://www.nuget.org/packages/NodeEditorAvalonia/) | [NodeEditorAvalonia](https://www.nuget.org/packages/NodeEditorAvalonia/) | [![Downloads](https://img.shields.io/nuget/dt/NodeEditorAvalonia.svg)](https://www.nuget.org/packages/NodeEditorAvalonia/) |
+| [![NuGet](https://img.shields.io/nuget/v/NodeEditorAvalonia.Model.svg)](https://www.nuget.org/packages/NodeEditorAvalonia.Model/) | [NodeEditorAvalonia.Model](https://www.nuget.org/packages/NodeEditorAvalonia.Model/) | [![Downloads](https://img.shields.io/nuget/dt/NodeEditorAvalonia.Model.svg)](https://www.nuget.org/packages/NodeEditorAvalonia.Model/) |
+| [![NuGet](https://img.shields.io/nuget/v/NodeEditorAvalonia.Mvvm.svg)](https://www.nuget.org/packages/NodeEditorAvalonia.Mvvm/) | [NodeEditorAvalonia.Mvvm](https://www.nuget.org/packages/NodeEditorAvalonia.Mvvm/) | [![Downloads](https://img.shields.io/nuget/dt/NodeEditorAvalonia.Mvvm.svg)](https://www.nuget.org/packages/NodeEditorAvalonia.Mvvm/) |
+| [![NuGet](https://img.shields.io/nuget/v/NodeEditorLogic.Core.svg)](https://www.nuget.org/packages/NodeEditorLogic.Core/) | [NodeEditorLogic.Core](https://www.nuget.org/packages/NodeEditorLogic.Core/) | [![Downloads](https://img.shields.io/nuget/dt/NodeEditorLogic.Core.svg)](https://www.nuget.org/packages/NodeEditorLogic.Core/) |
+| [![NuGet](https://img.shields.io/nuget/v/NodeEditorLogic.Editor.svg)](https://www.nuget.org/packages/NodeEditorLogic.Editor/) | [NodeEditorLogic.Editor](https://www.nuget.org/packages/NodeEditorLogic.Editor/) | [![Downloads](https://img.shields.io/nuget/dt/NodeEditorLogic.Editor.svg)](https://www.nuget.org/packages/NodeEditorLogic.Editor/) |
+| [![NuGet](https://img.shields.io/nuget/v/NodeEditor.Base.svg)](https://www.nuget.org/packages/NodeEditor.Base/) | [NodeEditor.Base](https://www.nuget.org/packages/NodeEditor.Base/) | [![Downloads](https://img.shields.io/nuget/dt/NodeEditor.Base.svg)](https://www.nuget.org/packages/NodeEditor.Base/) |
+| [![NuGet](https://img.shields.io/nuget/v/NodeEditor.Logic.svg)](https://www.nuget.org/packages/NodeEditor.Logic/) | [NodeEditor.Logic](https://www.nuget.org/packages/NodeEditor.Logic/) | [![Downloads](https://img.shields.io/nuget/dt/NodeEditor.Logic.svg)](https://www.nuget.org/packages/NodeEditor.Logic/) |
 
 A node editor control for Avalonia.
 
@@ -77,7 +84,11 @@ You can find the packages here [NuGet](https://www.nuget.org/packages/NodeEditor
 
 * [NodeEditorAvalonia](https://www.nuget.org/packages/NodeEditorAvalonia) - The main package with Avalonia controls and default theme.
 * [NodeEditorAvalonia.Model](https://www.nuget.org/packages/NodeEditorAvalonia.Model) - The base interfaces used in controls and view models.
-* [NodeEditorAvalonia.MVVM](https://www.nuget.org/packages/NodeEditorAvalonia.MVVM) - The MVVM view models with default implementation.
+* [NodeEditorAvalonia.Mvvm](https://www.nuget.org/packages/NodeEditorAvalonia.Mvvm) - The MVVM view models with default implementation.
+* [NodeEditorLogic.Core](https://www.nuget.org/packages/NodeEditorLogic.Core) - Core logic sample models and services used by LogicLab.
+* [NodeEditorLogic.Editor](https://www.nuget.org/packages/NodeEditorLogic.Editor) - LogicLab editor-specific types and tooling.
+* [NodeEditor.Base](https://www.nuget.org/packages/NodeEditor.Base) - Base sample assets and view models.
+* [NodeEditor.Logic](https://www.nuget.org/packages/NodeEditor.Logic) - LogicLab sample assets and view models.
 
 ### Package Sources
 

build-docs.ps1

@@ -0,0 +1,3 @@
+$env:IsDocFx = 'true'
+dotnet tool restore
+dotnet docfx docfx/docfx.json

build-docs.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+export IsDocFx=true
+dotnet tool restore
+dotnet docfx docfx/docfx.json

build/Assets/Icon.png

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+dotnet tool restore
+dotnet docfx docfx/docfx.json