Merge pull request #2550 from strictdoc-project/stanislaw/release

docs: update release notes and roadmap

Author: stanislaw

developer/drawio/Roadmap.drawio

@@ -369,8 +369,8 @@
         <mxCell id="jwnssjy23zgWTyzq0ZdY-3" value="UI/UX rework of Source View screen" style="text;html=1;strokeColor=#82b366;fillColor=#d5e8d4;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;" parent="5Hoejhb2v4ojji3GJ6aL-5" vertex="1">
           <mxGeometry x="-860" y="1350" width="190" height="70" as="geometry" />
         </mxCell>
-        <mxCell id="jwnssjy23zgWTyzq0ZdY-4" value="Document/requirement validations" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;fillColor=#fff2cc;strokeColor=#d6b656;" parent="5Hoejhb2v4ojji3GJ6aL-5" vertex="1">
-          <mxGeometry x="340" y="900" width="150" height="70" as="geometry" />
+        <mxCell id="jwnssjy23zgWTyzq0ZdY-4" value="Document/node&lt;div&gt;validations&lt;div&gt;(static HTML)&lt;/div&gt;&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;fillColor=#d5e8d4;strokeColor=#82b366;" parent="5Hoejhb2v4ojji3GJ6aL-5" vertex="1">
+          <mxGeometry x="340" y="900" width="110" height="70" as="geometry" />
         </mxCell>
         <mxCell id="jwnssjy23zgWTyzq0ZdY-5" value="&lt;font style=&quot;color: rgb(0, 0, 0);&quot;&gt;Links to external URLs and other content&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" parent="5Hoejhb2v4ojji3GJ6aL-5" vertex="1">
           <mxGeometry x="600" y="1170" width="150" height="70" as="geometry" />
@@ -457,17 +457,20 @@
           <mxGeometry x="250" y="1440" width="460" height="70" as="geometry" />
         </mxCell>
         <mxCell id="FQoGO6Vod0G9-xvB3XtP-1" value="&lt;div&gt;&lt;font style=&quot;color: rgb(0, 0, 0);&quot;&gt;Support parsing Ada source code&lt;/font&gt;&lt;/div&gt;&lt;font style=&quot;color: rgb(0, 0, 0);&quot;&gt;(StrictDoc parser)&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;fillColor=#f5f5f5;strokeColor=#666666;fontColor=#333333;" parent="5Hoejhb2v4ojji3GJ6aL-5" vertex="1">
-          <mxGeometry x="560" y="1260" width="130" height="70" as="geometry" />
+          <mxGeometry x="690" y="990" width="130" height="70" as="geometry" />
         </mxCell>
         <mxCell id="eRPcp-Zo6v9222eVP6_e-1" value="&lt;div&gt;StrictDoc configuration with a Python file (strictdoc_config.py&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;fillColor=#d5e8d4;strokeColor=#82b366;" parent="5Hoejhb2v4ojji3GJ6aL-5" vertex="1">
           <mxGeometry x="180" y="1080" width="140" height="70" as="geometry" />
         </mxCell>
-        <mxCell id="eRPcp-Zo6v9222eVP6_e-2" value="&lt;div&gt;Reading SDoc nodes from source files — Further work&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;fillColor=#fff2cc;strokeColor=#d6b656;" parent="5Hoejhb2v4ojji3GJ6aL-5" vertex="1">
-          <mxGeometry x="240" y="1260" width="160" height="70" as="geometry" />
+        <mxCell id="eRPcp-Zo6v9222eVP6_e-2" value="&lt;div&gt;Reading SDoc nodes from source files — Further work driven by Linux Kernel Requirements Template proposal&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;fillColor=#fff2cc;strokeColor=#d6b656;" parent="5Hoejhb2v4ojji3GJ6aL-5" vertex="1">
+          <mxGeometry x="240" y="1260" width="300" height="70" as="geometry" />
         </mxCell>
-        <mxCell id="2Au77a0Va1j8vjX5-GUo-1" value="Diff: Included documents" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="5Hoejhb2v4ojji3GJ6aL-5">
+        <mxCell id="2Au77a0Va1j8vjX5-GUo-1" value="Diff: Included documents" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;fillColor=#d5e8d4;strokeColor=#82b366;" parent="5Hoejhb2v4ojji3GJ6aL-5" vertex="1">
           <mxGeometry x="310" y="990" width="70" height="70" as="geometry" />
         </mxCell>
+        <mxCell id="OCJ0sT8p7vvNHOtbERSk-1" value="Linking nodes via MID instead of UID" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="5Hoejhb2v4ojji3GJ6aL-5">
+          <mxGeometry x="470" y="900" width="90" height="70" as="geometry" />
+        </mxCell>
       </root>
     </mxGraphModel>
   </diagram>

docs/_assets/StrictDoc_Workspace-Roadmap.drawio.png

@@ -54,7 +54,7 @@ MID: 12345f3b28ea4bfe9ca8afe6b21826a8
 STATEMENT: >>>
 This release includes several enhancements, the removal of legacy @sdoc markers, several bug fixes, and improvements for edge cases.
 
-The Diff/Changelog feature has been extended to support the new --generate-diff-git option which allows generating the Diff/Changelog screens for a given pair of Git revisions.
+The Diff/Changelog feature has been extended to support the new ``--generate-diff-git`` option which allows generating the Diff/Changelog screens for a given pair of Git revisions.
 
 The legacy ``@sdoc`` marker has been removed from the codebase. From now on, only the ``@relation`` markers are recognized when linking requirements with source code files.
 
@@ -67,7 +67,7 @@ Thanks to @kerfallaCisse for reporting this issue.
 
 The HTML2PDF generator has been fixed to correctly resolve document paths when printing a bundle document that includes other documents. This edge case involved a combination of three features — HTML2PDF, bundle documents, and composable documents — that had not previously been tested to work together. Thanks to @CMon for reporting this issue.
 
-The source code node parser has been updated to recognize only field names that are defined in the corresponding document grammar. This prevents the parser from incorrectly interpreting unrelated ``FIELD: VALUE`` strings found in source code. Thanks to @haxtibal for contributing this improvement.
+The source code node parser has been updated to recognize only those field names that are defined in the corresponding document grammar. This change prevents the parser from incorrectly interpreting unrelated ``FIELD: VALUE`` strings found in source code. In addition, several improvements have been made to the functionality that extracts SDoc nodes from source code comments, inspired by our proof-of-concept work on modeling Linux kernel requirements directly within the Linux source code. Some aspects of this work are not yet documented but will be once the overall concept becomes more mature. Many thanks to @haxtibal for contributing these improvements.
 <<<
 
 [[/SECTION]]