Skip to content

Commit 9125120

Browse files
stanislawstanislaw
authored
Merge pull request #2528 from strictdoc-project/stanislaw/docs
docs: update roadmap and workspace
2 parents 6bc1da1 + 99cfa6c commit 9125120

File tree

3 files changed

+103
-5
lines changed

3 files changed

+103
-5
lines changed

‎developer/drawio/Roadmap.drawio‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<mxfile host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/28.1.2 Chrome/138.0.7204.243 Electron/37.4.0 Safari/537.36" version="28.1.2">
22
<diagram name="Roadmap" id="QL4QDE5GQBR7DcBM7GMb">
3-
<mxGraphModel dx="2701" dy="3597" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="2339" pageHeight="3300" math="0" shadow="0">
3+
<mxGraphModel dx="3125" dy="3932" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="2339" pageHeight="3300" math="0" shadow="0">
44
<root>
55
<mxCell id="0" />
66
<object label="Background" id="e4xbaoC47YMUbLc9hft--7">
@@ -373,7 +373,7 @@
373373
<mxGeometry x="340" y="900" width="150" height="70" as="geometry" />
374374
</mxCell>
375375
<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">
376-
<mxGeometry x="540" y="1170" width="150" height="70" as="geometry" />
376+
<mxGeometry x="600" y="1170" width="150" height="70" as="geometry" />
377377
</mxCell>
378378
<mxCell id="jwnssjy23zgWTyzq0ZdY-6" value="JUnit XML -&amp;gt; SDoc test report generator" 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">
379379
<mxGeometry x="-850" y="1260" width="120" height="70" as="geometry" />
@@ -448,7 +448,7 @@
448448
<mxGeometry x="-180" y="1260" width="130" height="70" as="geometry" />
449449
</mxCell>
450450
<mxCell id="CJRkyjP5KVGCwtUBZvE2-1" value="HTML2PDF more layout tests" 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">
451-
<mxGeometry x="129" y="1170" width="321" height="70" as="geometry" />
451+
<mxGeometry x="129" y="1170" width="401" height="70" as="geometry" />
452452
</mxCell>
453453
<mxCell id="CJRkyjP5KVGCwtUBZvE2-2" value="&lt;div&gt;StrictDoc qualification:&lt;/div&gt;&lt;div&gt;Increasing branch code coverage from 97%,&lt;/div&gt;&lt;div&gt;add traces between L2 and source code&lt;/div&gt;" style="text;html=1;strokeColor=#d6b656;fillColor=#fff2cc;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=0;fontSize=16;" parent="5Hoejhb2v4ojji3GJ6aL-5" vertex="1">
454454
<mxGeometry x="250" y="1350" width="460" height="70" as="geometry" />
@@ -462,9 +462,12 @@
462462
<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">
463463
<mxGeometry x="180" y="1080" width="140" height="70" as="geometry" />
464464
</mxCell>
465-
<mxCell id="eRPcp-Zo6v9222eVP6_e-2" value="&lt;div&gt;Reading SDoc nodes from source files&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">
465+
<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">
466466
<mxGeometry x="240" y="1260" width="160" height="70" as="geometry" />
467467
</mxCell>
468+
<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">
469+
<mxGeometry x="310" y="990" width="70" height="70" as="geometry" />
470+
</mxCell>
468471
</root>
469472
</mxGraphModel>
470473
</diagram>

‎developer/drawio/Workspace.drawio‎

Lines changed: 96 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<mxfile host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/28.1.2 Chrome/138.0.7204.243 Electron/37.4.0 Safari/537.36" version="28.1.2" pages="7">
1+
<mxfile host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/28.1.2 Chrome/138.0.7204.243 Electron/37.4.0 Safari/537.36" version="28.1.2" pages="8">
22
<diagram id="odpjYmKa3UCVNtoiXPh0" name="Requirements verification">
33
<mxGraphModel dx="706" dy="179" grid="0" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
44
<root>
@@ -730,6 +730,101 @@
730730
</root>
731731
</mxGraphModel>
732732
</diagram>
733+
<diagram id="r9r9qBKeZLxmEPPqQKe1" name="Linux work">
734+
<mxGraphModel dx="1613" dy="1801" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
735+
<root>
736+
<mxCell id="0" />
737+
<mxCell id="1" parent="0" />
738+
<mxCell id="182MAqE3Yp3qsp92a0fV-32" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" edge="1" parent="1" source="182MAqE3Yp3qsp92a0fV-1" target="182MAqE3Yp3qsp92a0fV-31">
739+
<mxGeometry relative="1" as="geometry" />
740+
</mxCell>
741+
<mxCell id="182MAqE3Yp3qsp92a0fV-1" value="User-provided node/document/project validations" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="1">
742+
<mxGeometry x="640" y="-80" width="120" height="60" as="geometry" />
743+
</mxCell>
744+
<mxCell id="182MAqE3Yp3qsp92a0fV-2" value="Write tree-sitter AST back to source code" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
745+
<mxGeometry x="160" y="-80" width="120" height="60" as="geometry" />
746+
</mxCell>
747+
<mxCell id="182MAqE3Yp3qsp92a0fV-4" value="Done" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
748+
<mxGeometry x="-80" y="40" width="120" height="60" as="geometry" />
749+
</mxCell>
750+
<mxCell id="182MAqE3Yp3qsp92a0fV-5" value="WIP" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="1">
751+
<mxGeometry x="-80" y="100" width="120" height="60" as="geometry" />
752+
</mxCell>
753+
<mxCell id="182MAqE3Yp3qsp92a0fV-6" value="TBD" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
754+
<mxGeometry x="-80" y="160" width="120" height="60" as="geometry" />
755+
</mxCell>
756+
<mxCell id="182MAqE3Yp3qsp92a0fV-18" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="182MAqE3Yp3qsp92a0fV-11" target="182MAqE3Yp3qsp92a0fV-14">
757+
<mxGeometry relative="1" as="geometry" />
758+
</mxCell>
759+
<mxCell id="182MAqE3Yp3qsp92a0fV-11" value="Agree whether MID or UID will be used for identifiers or&amp;nbsp;&lt;span style=&quot;background-color: transparent; color: light-dark(rgb(0, 0, 0), rgb(255, 255, 255));&quot;&gt;SPDX-Req-ID.&lt;/span&gt;" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
760+
<mxGeometry x="390" y="-80" width="160" height="80" as="geometry" />
761+
</mxCell>
762+
<mxCell id="182MAqE3Yp3qsp92a0fV-19" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="182MAqE3Yp3qsp92a0fV-14" target="182MAqE3Yp3qsp92a0fV-15">
763+
<mxGeometry relative="1" as="geometry" />
764+
</mxCell>
765+
<mxCell id="182MAqE3Yp3qsp92a0fV-14" value="Make&lt;div&gt;the *ID field configurable in StrictDoc config.&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
766+
<mxGeometry x="410" y="30" width="120" height="60" as="geometry" />
767+
</mxCell>
768+
<mxCell id="182MAqE3Yp3qsp92a0fV-15" value="Make&lt;div&gt;RELATIONS work against *ID field&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
769+
<mxGeometry x="410" y="120" width="120" height="60" as="geometry" />
770+
</mxCell>
771+
<mxCell id="182MAqE3Yp3qsp92a0fV-16" value="" style="shape=umlActor;verticalLabelPosition=bottom;verticalAlign=top;html=1;outlineConnect=0;" vertex="1" parent="1">
772+
<mxGeometry x="560" y="-70" width="30" height="60" as="geometry" />
773+
</mxCell>
774+
<mxCell id="182MAqE3Yp3qsp92a0fV-26" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="182MAqE3Yp3qsp92a0fV-23" target="182MAqE3Yp3qsp92a0fV-25">
775+
<mxGeometry relative="1" as="geometry" />
776+
</mxCell>
777+
<mxCell id="182MAqE3Yp3qsp92a0fV-23" value="Sphinx compatibility" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
778+
<mxGeometry x="827" y="-80" width="120" height="60" as="geometry" />
779+
</mxCell>
780+
<mxCell id="182MAqE3Yp3qsp92a0fV-24" value="Rust support" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="1">
781+
<mxGeometry x="1000" y="-80" width="120" height="60" as="geometry" />
782+
</mxCell>
783+
<mxCell id="182MAqE3Yp3qsp92a0fV-29" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="182MAqE3Yp3qsp92a0fV-25" target="182MAqE3Yp3qsp92a0fV-27">
784+
<mxGeometry relative="1" as="geometry" />
785+
</mxCell>
786+
<mxCell id="182MAqE3Yp3qsp92a0fV-25" value="Basic sphinx-strictdoc skeleton POC" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
787+
<mxGeometry x="827" y="30" width="120" height="60" as="geometry" />
788+
</mxCell>
789+
<mxCell id="182MAqE3Yp3qsp92a0fV-27" value="Discuss which screens have to be integrated into Linux Sphinx" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
790+
<mxGeometry x="807" y="120" width="160" height="80" as="geometry" />
791+
</mxCell>
792+
<mxCell id="182MAqE3Yp3qsp92a0fV-28" value="" style="shape=umlActor;verticalLabelPosition=bottom;verticalAlign=top;html=1;outlineConnect=0;" vertex="1" parent="1">
793+
<mxGeometry x="977" y="130" width="30" height="60" as="geometry" />
794+
</mxCell>
795+
<mxCell id="182MAqE3Yp3qsp92a0fV-30" value="SPDX-Req-ID auto-generation" style="swimlane;" vertex="1" parent="1">
796+
<mxGeometry x="140" y="210" width="420" height="120" as="geometry" />
797+
</mxCell>
798+
<mxCell id="182MAqE3Yp3qsp92a0fV-21" value="For selected *ID field, implement auto-generation in source code" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="182MAqE3Yp3qsp92a0fV-30">
799+
<mxGeometry x="20" y="40" width="120" height="60" as="geometry" />
800+
</mxCell>
801+
<mxCell id="182MAqE3Yp3qsp92a0fV-12" value="For selected UID, MID, *ID field, implement auto-generation in SDoc" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="182MAqE3Yp3qsp92a0fV-30">
802+
<mxGeometry x="270" y="40" width="120" height="60" as="geometry" />
803+
</mxCell>
804+
<mxCell id="182MAqE3Yp3qsp92a0fV-20" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" edge="1" parent="1" source="182MAqE3Yp3qsp92a0fV-15" target="182MAqE3Yp3qsp92a0fV-12">
805+
<mxGeometry relative="1" as="geometry" />
806+
</mxCell>
807+
<mxCell id="182MAqE3Yp3qsp92a0fV-22" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="182MAqE3Yp3qsp92a0fV-2" target="182MAqE3Yp3qsp92a0fV-21">
808+
<mxGeometry relative="1" as="geometry" />
809+
</mxCell>
810+
<mxCell id="182MAqE3Yp3qsp92a0fV-31" value="Linux kernel-specific validations for SPDX-Req-* fields." style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
811+
<mxGeometry x="640" y="120" width="120" height="60" as="geometry" />
812+
</mxCell>
813+
<mxCell id="182MAqE3Yp3qsp92a0fV-34" value="Long-term challenge: &#xa;Very large projects" style="swimlane;" vertex="1" parent="1">
814+
<mxGeometry x="1241" y="-80" width="279" height="280" as="geometry" />
815+
</mxCell>
816+
<mxCell id="182MAqE3Yp3qsp92a0fV-35" value="&lt;span style=&quot;background-color: transparent; color: light-dark(rgb(0, 0, 0), rgb(255, 255, 255));&quot;&gt;Maybe:&lt;/span&gt;&lt;div&gt;&lt;span style=&quot;background-color: transparent; color: light-dark(rgb(0, 0, 0), rgb(255, 255, 255));&quot;&gt;Replace textX with tree-sitter-strictdoc&lt;/span&gt;&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="182MAqE3Yp3qsp92a0fV-34">
817+
<mxGeometry x="19" y="40" width="241" height="60" as="geometry" />
818+
</mxCell>
819+
<mxCell id="182MAqE3Yp3qsp92a0fV-36" value="Sharing large Traceability Index between subprocesses becomes slow" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="182MAqE3Yp3qsp92a0fV-34">
820+
<mxGeometry x="19" y="120" width="241" height="60" as="geometry" />
821+
</mxCell>
822+
<mxCell id="182MAqE3Yp3qsp92a0fV-37" value="&lt;span style=&quot;background-color: transparent; color: light-dark(rgb(0, 0, 0), rgb(255, 255, 255));&quot;&gt;Maybe:&lt;/span&gt;&lt;div&gt;&lt;br&gt;&lt;div&gt;&lt;span style=&quot;background-color: transparent; color: light-dark(rgb(0, 0, 0), rgb(255, 255, 255));&quot;&gt;Rewrite text-heavy components in Rust&lt;/span&gt;&lt;/div&gt;&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="182MAqE3Yp3qsp92a0fV-34">
823+
<mxGeometry x="19" y="200" width="241" height="60" as="geometry" />
824+
</mxCell>
825+
</root>
826+
</mxGraphModel>
827+
</diagram>
733828
<diagram id="VQ_LBOJAHuRUtiQ3O9RX" name="WIP">
734829
<mxGraphModel dx="2500" dy="1972" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="0" pageScale="1" pageWidth="827" pageHeight="1169" background="none" math="0" shadow="0">
735830
<root>

‎docs/_assets/StrictDoc_Workspace-Roadmap.drawio.png‎

8.93 KB
Loading

0 commit comments

Comments
 (0)