Enhance documentation with UI companion details, fix typos, and update prerequisites for .NET versions

Author: PTKu

docfx/api/index.md

@@ -1,3 +1,12 @@
 # AXSharp API Documentation
 
-![](~/images/banner.png)
+![](~/images/banner.png)
+
+Browse the auto-generated API reference for all AX# packages:
+
+- **AXSharp.Connector** — core connectivity layer, twin objects, and data exchange primitives
+- **AXSharp.Compiler** — twin compiler (ixc) internals and code generation
+- **AXSharp.Blazor** — Blazor UI rendering components and auto-generated views
+- **AXSharp.Abstractions** — shared interfaces and presentation attributes
+
+Use the table of contents on the left to navigate namespaces and types.

docfx/articles/connectors/README.md

@@ -78,8 +78,8 @@ During the batched read operation, the values are stored in *LastValue* property
 
 During a batched write operation, the values written to the controller were retrieved from the *Cyclic* property of the corresponding Primitive Twin.
 
-> **NOTE** 
-> Accessing *Cyclic* property for **writing** will not result in an autmatic subscription for cyclic reading. Acessing the *LastValue* property will neither result in an automatic subcription for reading.
+> **NOTE**
+> Accessing *Cyclic* property for **writing** will not result in an automatic subscription for cyclic reading. Accessing the *LastValue* property will neither result in an automatic subscription for reading.
 
 ~~~ C#
 // in this namespace are extension methods for batched operations.
@@ -93,11 +93,11 @@ public class BatchedAccess
        await Entry.PlcTwin.Settings.ReadAsync();
 
         // Write values to the console
-        Console.WriteLine($"{Entry.PlcTwin.Settings.PosX.Symbol}:{Entry.PlcTwin.MAIN.Settings.PosX.LastValue});
+        Console.WriteLine($"{Entry.PlcTwin.Settings.PosX.Symbol}:{Entry.PlcTwin.Settings.PosX.LastValue}");
 
-        Console.WriteLine($"{Entry.PlcTwin.Settings.PosY.Symbol}:{Entry.PlcTwin.Settings.PosY.LastValue});
+        Console.WriteLine($"{Entry.PlcTwin.Settings.PosY.Symbol}:{Entry.PlcTwin.Settings.PosY.LastValue}");
 
-        Console.WriteLine($"{Entry.PlcTwin.Settings.PosZ.Symbol}:{Entry.PlcTwin.Settings.PosZ.LastValue});
+        Console.WriteLine($"{Entry.PlcTwin.Settings.PosZ.Symbol}:{Entry.PlcTwin.Settings.PosZ.LastValue}");
     }
 
 
@@ -108,11 +108,13 @@ public class BatchedAccess
        Entry.PlcTwin.Settings.PosZ.Cyclic = 130.0f;
 
         // Writes all values of the settings structure.
-       await Entry.PlcController.MAIN.Settings.WriteAsynch();
+       await Entry.PlcTwin.Settings.WriteAsync();
     }
 }
 ~~~
 
+## Polling
+
 Polling allows an application to query a structure or variable at different intervals. The values are stored in the `Cyclic` property of value types. The polled variables are retrieved from the controller in the same way as during cyclic reading but at a specified interval. Unlike automatic subscription mode, the polled values can be unsubscribed.
 
 To enable polling, the subscription of the twin connector must be set to `Polling`.
@@ -256,7 +258,7 @@ _length : REAL;
 ~~~
 
 ~~~ C#
-// Writes unit of the '_lenght' variable to the console.
+// Writes unit of the '_length' variable to the console.
 System.Console.WriteLine(PlcTwin._app._length.AttributeUnits);
 ~~~
 
@@ -334,10 +336,10 @@ VAR
     someWString : WSTRING;
 END_VAR
 
-someString := '<#This woule be localized#> and this would stay as it is';
+someString := '<#This would be localized#> and this would stay as it is';
 
 
-someWString := "<#This woule be localized#> and this would stay as it is";
+someWString := "<#This would be localized#> and this would stay as it is";
 ~~~
 
 Connectors implement features that allow localizing of the texts (controller defined and added attributes of string type). For the localization to work the twin assembly must be provided with a resource file (*.resx). Resource files can be generated using [ixr tool](~/articles/ixr/IXR.md). You will need to add the resource file to your **Twin project** and set the resource code generation to *public*.

docfx/articles/connectors/WebAPI.md

@@ -23,7 +23,7 @@ Here is an example on how to set polling subscription mode:
 Entry.Plc.Connector.SubscriptionMode = AXSharp.Connector.ReadSubscriptionMode.Polling;
 ```
 
-For more details about polling within your components, see [Polling Data from the Controller in Components](../blazor/LIBRARIES.md#polling-data-from-the-plc) and [General Polling](README.md#polling).
+For more details about polling within your components, see [Polling Data from the Controller in Components](../blazor/LIBRARIES.md#optimizing-plc-data-polling) and [General Polling](README.md#polling).
 
 ### Monitoring and Logging 
 

docfx/articles/intro.md

@@ -9,7 +9,7 @@
     * [Config file](~/articles/compiler/CONFIG_FILE.md)
     * [Packaging and dependencies](~/articles/compiler/PACKAGING.md)
 ---
-* [Documenation compiler](~/articles/ixd/IXD.md)
+* [Documentation compiler](~/articles/ixd/IXD.md)
 ---
 * [Resx compiler](~/articles/ixr/IXR.md)
 ---

docfx/articles/toc.yml

@@ -18,10 +18,12 @@
   - name: Packaging and dependencies
     href: ~/articles/compiler/PACKAGING.md
 
-- name: Documenation compiler
+- name: Documentation compiler
   href: ~/articles/ixd/IXD.md
 - name: Localizables compiler
   href: ~/articles/ixr/IXR.md
+- name: Localizables to Resx
+  href: ~/articles/ltr/LTR.md
 - name: Connectors
   href: ~/articles/connectors/README.md
   items:
@@ -38,4 +40,6 @@
     href: ~/articles/blazor/LIBRARIES.md
   - name: Blazor auto-rendering
     href: ~/articles/blazor/RENDERABLECONTENT.md
+- name: Coding style
+  href: ~/articles/general/CODING_STYLE.md
 

docfx/docfx.json

@@ -26,16 +26,16 @@
   ],
   "build": {
     "globalMetadata" : {
-        "_appTitle" : {"api/index.md" : "API"},
+        "_appTitle" : "AX#",
         "_appName" : "AX#",
-        "_appFooter" : " Generated by DocFx. © MTS spol. s r.o., MTS spol. s r.o., and awesome contributors",
+        "_appFooter" : " Generated by DocFx. © MTS spol. s r.o. and awesome contributors",
         "_enableSearch" : true,
         "_appFaviconPath" : "images/favicon.ico"        
     },
 
     "sitemap": {
       "baseUrl": "https://inxton.github.io/axsharp/",
-      "priority": 0.1,
+      "priority": 0.5,
       "changefreq": "weekly"
     },
 
@@ -65,17 +65,7 @@
         ]
       }
     ],
-    "overwrite": [
-      {
-        "files": [
-          "apidoc/**.md"
-        ],
-        "exclude": [
-          "obj/**",
-          "_site/**"
-        ]
-      }
-    ],
+    "overwrite": [],
     "dest": "../docs",
     "globalMetadataFiles": [],
     "fileMetadataFiles": [],

docfx/index.md

@@ -36,13 +36,9 @@ The presentations provide a mechanism for automated UI generation from PLC code.
 ## Prerequisites
 
 - [axcode](https://axcite.me)
-- [dotnet 6](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
-- [dotnet 7](https://dotnet.microsoft.com/en-us/download/dotnet/7.0)
-- [dotnet 7](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
+- [dotnet 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
 - [vscode](https://code.visualstudio.com/Download) or [vs2022](https://visualstudio.microsoft.com/vs/)
 
-> **Make sure you have installed both .NET6 and .NET7.**
-
 ## Getting started
 
 Make sure you meet all [prerequisites](#prerequisites).
@@ -66,7 +62,7 @@ There are different ways you can use to create new project. At this point we sup
 
 **IMPORTANT! Prepare your PLC and AX project**
 
-*Before you start using any of the method below yoiu will need to set up your PLC. Using TIA portal you need to enable WebAPI interface [see here](https://console.simatic-ax.siemens.io/docs/hwld/PlcWebServer) and [here](https://youtu.be/d9EX2FixY1A?t=151) is a very informative youtube video.*
+*Before you start using any of the methods below you will need to set up your PLC. Using TIA portal you need to enable WebAPI interface [see here](https://console.simatic-ax.siemens.io/docs/hwld/PlcWebServer) and [here](https://youtu.be/d9EX2FixY1A?t=151) is a very informative youtube video.*
 
 [!Video https://youtu.be/d9EX2FixY1A?t=151]
 
@@ -75,15 +71,9 @@ There are different ways you can use to create new project. At this point we sup
 
 Install AX# template package
 
-When using .NET7
 ~~~
 dotnet new install AXSharp.templates
 ~~~
-
-When using .NET6 and earlier
-~~~
-dotnet new --install AXSharp.templates
-~~~
 > [!NOTE]
 > Make sure all nuget feed sources are available at the time of installation of packages.
 If you are not sure run `dotnet nuget list source` and check that the sources listed are reachable.
@@ -107,11 +97,11 @@ Create new project from template
 
 ~~~
 dotnet new [shortname] -n YOUR_PROJECT_NAME
-#e.g. dotnet new axeblazor -n MyFristAXSharpBlazorProject
+#e.g. dotnet new axeblazor -n MyFirstAXSharpBlazorProject
 ~~~
 
 **When prompted about script execution allow the script to run (answer (Y)es) in order to finish the scaffolding of the project.**
-If you're creating the project using Visual Studion you will need to run the script manually.
+If you're creating the project using Visual Studio you will need to run the script manually.
 
 Consult README.md file located in your new project for additional information.
 
@@ -168,7 +158,7 @@ Copyright (C) 2022 author
   --version                      Display version information.
 ~~~
 
-Before usage apax commanad ensure that you are logged in
+Before usage apax command ensure that you are logged in
 ~~~
 apax login 
 ~~~