Add SDD aggregation into the core website (#3139)

nasa · Jan 15, 2025 · 334c525 · 334c525
1 parent 5a7452a
commit 334c525
Show file tree

Hide file tree

Showing 74 changed files with 93 additions and 282 deletions.
diff --git a/.github/actions/markdown-check/mlc-config.json b/.github/actions/markdown-check/mlc-config.json
@@ -11,6 +11,12 @@
       },
       {
         "pattern": "^\\.\\./tree/HEAD/"
+      },
+      {
+        "pattern": ".*\\.[chf]pp"
+      },
+      {
+        "pattern": "../../../.."
       }
     ]
 }
diff --git a/.github/actions/spelling/excludes.txt b/.github/actions/spelling/excludes.txt
@@ -100,3 +100,4 @@
 ^\Qdocs/Tutorials/FullSystemTutorial/Tutorial.md\E$
 ^\QSvc/FileUplink/test/ut/dest.bin\E$
 ignore$
+mlc-config.json
diff --git a/Drv/BlockDriver/docs/sdd.md b/Drv/BlockDriver/docs/sdd.md
@@ -1,4 +1,3 @@
-\page DrvBlockDriverComponent Drv::BlockDriver Component
 # Drv::BlockDriver Component
 
 ## 1. Introduction

diff --git a/Drv/ByteStreamDriverModel/docs/sdd.md b/Drv/ByteStreamDriverModel/docs/sdd.md
@@ -1,4 +1,3 @@
-\page DrvByteStreamDriverModel Drv::ByteStreamDriverModel Byte Stream Driver Model
 # Drv::ByteStreamDriverModel Byte Stream Driver Model
 
 The byte stream driver is a generic model for drivers implementing a "stream of bytes" interface. Typically these

diff --git a/Drv/Ip/docs/sdd.md b/Drv/Ip/docs/sdd.md
@@ -1,4 +1,3 @@
-\page DrvIp Drv::Ip IPv4 Socket Implementations
 # Drv::Ip IPv4 Socket Implementations
 
 This package contains utility classes to help interact with standard IPv4 (Berkeley) sockets. These classes implement the

diff --git a/Drv/StreamCrossover/docs/sdd.md b/Drv/StreamCrossover/docs/sdd.md
@@ -1,4 +1,3 @@
-\page DrvStreamCrossover Drv::StreamCrossover Stream Crossover Component
 # Drv::StreamCrossover Stream Crossover Component
 
 The Stream Crossover component allows a connection of byte stream driver model ports of type ByteStreamRecv and

diff --git a/Drv/TcpClient/docs/sdd.md b/Drv/TcpClient/docs/sdd.md
@@ -1,4 +1,3 @@
-\page DrvTcpClient Drv::TcpClient Component
 # Drv::TcpClient TCP Client Component
 
 The TCP client component bridges the byte stream driver model interface to a remote TCP server to which this tcp client

diff --git a/Drv/TcpServer/docs/sdd.md b/Drv/TcpServer/docs/sdd.md
@@ -1,4 +1,3 @@
-\page DrvTcpServer Drv::TcpServer Component
 # Drv::TcpServer Tcp Server Component
 
 The TCP server component bridges the byte stream driver model interface to a remote TCP client to which this tcp server

diff --git a/Drv/Udp/docs/sdd.md b/Drv/Udp/docs/sdd.md
@@ -1,4 +1,3 @@
-\page DrvUdp Drv::Udp Component
 # Drv::Udp UDP Component
 
 The UDP client component bridges the byte stream driver model interface to a remote UDP port to which this udp component

diff --git a/Fw/Buffer/docs/sdd.md b/Fw/Buffer/docs/sdd.md
@@ -1,4 +1,3 @@
-\page FwBufferSerializableBufferGetBufferSend Fw::Buffer Serializable / Fw::BufferGet Port / Fw::BufferSend Port
 # Fw::Buffer Serializable / Fw::BufferGet Port / Fw::BufferSend Port
 
 ## 1 Introduction

diff --git a/Fw/Cmd/docs/sdd.md b/Fw/Cmd/docs/sdd.md
@@ -1,4 +1,3 @@
-\page FwCmdFwCmdResponseFwCmdReg Fw::Cmd / Fw::CmdResponse / Fw::CmdReg Ports
 # Fw::Cmd / Fw::CmdResponse / Fw::CmdReg Ports
 
 ## 1. Introduction

diff --git a/Fw/Com/docs/sdd.md b/Fw/Com/docs/sdd.md
@@ -1,4 +1,3 @@
-\page FwComPort Fw::Com Port
 # Fw::Com Port
 
 ## 1. Introduction

diff --git a/Fw/Dp/docs/sdd.md b/Fw/Dp/docs/sdd.md
@@ -1,12 +1,11 @@
-\page FwDp Framework Support for Data Products
-# Framework Support for Data Products
+# Fw::Dp Framework Support for Data Products
 
 ## 1. Introduction
 
 This build module defines FPP ports and C++ classes that support
 the collection and storage of data products.
 For more information on data products and records, see the
-[data products documentation](../../../docs/documentation/user-manual/design/data-products.md).
+[data products documentation](../../../../../user-manual/design/data-products.md).
 
 ## 2. Configuration
 
@@ -82,7 +81,7 @@ The header hash has the following format.
 
 |Field Name|Serialized Size|Description|
 |----------|---------------|-----------|
-|`Header Hash`|[`HASH_DIGEST_LENGTH`](../../../Utils/Hash/README.md)|The hash value guarding the header.|
+|`Header Hash`|[`HASH_DIGEST_LENGTH`](../../../../api/cpp/html/index.html)|The hash value guarding the header.|
 
 #### 5.1.3. Data
 
@@ -119,7 +118,7 @@ The data hash has the following format.
 
 |Field Name|Serialized Size|Description|
 |----------|---------------|-----------|
-|`Data Hash`|[`HASH_DIGEST_LENGTH`](../../../Utils/Hash/README.md)|The hash value guarding the data.|
+|`Data Hash`|[`HASH_DIGEST_LENGTH`](../../../../api/cpp/html/index.html)|The hash value guarding the data.|
 
 ### 5.2. Further Information
 

diff --git a/Fw/FilePacket/docs/sdd.md b/Fw/FilePacket/docs/sdd.md
@@ -1,4 +1,3 @@
-\page FwFilePacketClasses Fw::FilePacket Classes
 # Fw::FilePacket Classes
 
 ## 1 Introduction

diff --git a/Fw/Log/docs/sdd.md b/Fw/Log/docs/sdd.md
@@ -1,4 +1,3 @@
-\page FwLogLogText Fw::Log, Fw::LogText Ports
 # Fw::Log / Fw::LogText Ports
 
 ## 1. Introduction

diff --git a/Fw/Obj/docs/sdd.md b/Fw/Obj/docs/sdd.md
@@ -1,4 +1,3 @@
-\page FwObjClasses Fw::Obj Classes
 # Fw::Obj Classes
 
 ## 1. Introduction

diff --git a/Fw/Port/docs/sdd.md b/Fw/Port/docs/sdd.md
@@ -1,4 +1,3 @@
-\page FwPortClasses Fw::Port Classes
 # Fw::Port Classes
 
 ## 1. Introduction

diff --git a/Fw/Prm/docs/sdd.md b/Fw/Prm/docs/sdd.md
@@ -1,4 +1,3 @@
-\page FwPrmGetPrmSet Fw::PrmGet / PrmSet Ports
 # Fw::PrmGet / PrmSet Ports
 
 ## 1. Introduction

diff --git a/Fw/Time/docs/sdd.md b/Fw/Time/docs/sdd.md
@@ -1,4 +1,3 @@
-\page FwTimePort Fw::Time Port
 # Fw::Time Port
 
 ## 1. Introduction

diff --git a/Fw/Tlm/docs/sdd.md b/Fw/Tlm/docs/sdd.md
@@ -1,4 +1,3 @@
-\page FwTlmPort Fw::Tlm Port
 # Fw::Tlm Port
 
 ## 1. Introduction

diff --git a/Fw/Types/docs/sdd.md b/Fw/Types/docs/sdd.md
@@ -1,4 +1,3 @@
-\page FwTypeClasses Fw::Type Classes and Types
 # Fw::Type Classes and Types
 
 ## 1. Introduction

diff --git a/Ref/PingReceiver/docs/sdd.md b/Ref/PingReceiver/docs/sdd.md
@@ -1,4 +1,3 @@
-\page RefPingReceiverComponent Ref::PingReceiver Component
 # Ref::PingReceiver Component
 
 ## 1. Introduction

diff --git a/Ref/RecvBuffApp/docs/sdd.md b/Ref/RecvBuffApp/docs/sdd.md
@@ -1,4 +1,3 @@
-\page RefRecvBuffAppComponent Ref::RecvBuffApp Component
 # Ref::RecvBuffApp Component
 
 ## 1. Introduction

diff --git a/Ref/SendBuffApp/docs/sdd.md b/Ref/SendBuffApp/docs/sdd.md
@@ -1,4 +1,3 @@
-\page RefSendBuffAppComponent Ref::SendBuffApp Component
 # Ref::SendBuffApp Component
 
 ## 1. Introduction

diff --git a/Ref/SignalGen/docs/sdd.md b/Ref/SignalGen/docs/sdd.md
@@ -1,4 +1,3 @@
-\page RefSignalGenComponent Ref::SignalGen Component
 # Ref::SignalGen Component
 
 ## 1. Introduction

diff --git a/Svc/ActiveLogger/docs/sdd.md b/Svc/ActiveLogger/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcActiveLoggerComponent Svc::ActiveLogger Component
 # Svc::ActiveLogger Component
 
 ## 1. Introduction

diff --git a/Svc/ActiveRateGroup/docs/sdd.md b/Svc/ActiveRateGroup/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcActiveRateGroupComponent Svc::ActiveRateGroup Component
 # Svc::ActiveRateGroup Component
 
 ## 1. Introduction

diff --git a/Svc/ActiveTextLogger/docs/sdd.md b/Svc/ActiveTextLogger/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcActiveTextLoggerComponent Svc::ActiveTextLogger Component
 # Svc::ActiveTextLogger Component
 
 ## 1. Introduction

diff --git a/Svc/AssertFatalAdapter/docs/sdd.md b/Svc/AssertFatalAdapter/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcAssertFatalAdapterComponent Svc::AssertFatalAdapter Component
 # Svc::AssertFatalAdapter Component
 
 ## 1. Introduction

diff --git a/...fferAccumulator/docs/BufferAccumulator.md → Svc/BufferAccumulator/docs/sdd.md b/...fferAccumulator/docs/BufferAccumulator.md → Svc/BufferAccumulator/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcBufferAccumulatorComponent Svc::BufferAccumulator Component
 # BufferAccumulator Component Dictionary
 
 

diff --git a/Svc/BufferManager/docs/sdd.md b/Svc/BufferManager/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcBufferManagerComponent Svc::BufferManager Component
 # Svc::BufferManager
 
 ## 1 Introduction

diff --git a/Svc/BufferRepeater/docs/sdd.md b/Svc/BufferRepeater/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcBufferRepeaterComponent Svc::BufferRepeater Component
 # Svc::BufferRepeater: Buffer Repeater (Passive Component)
 
 ## 1. Introduction

diff --git a/Svc/CmdDispatcher/docs/sdd.md b/Svc/CmdDispatcher/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcCmdDispatcherComponent Svc::CmdDispatcher Component
 # Svc::CmdDispatcher Component
 
 ## 1. Introduction

diff --git a/Svc/CmdSequencer/docs/sdd.md b/Svc/CmdSequencer/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcCmdSequencerComponent Svc::CmdSequencer Component
 # Svc::CmdSequencer Component
 
 ## 1 Introduction

diff --git a/Svc/CmdSplitter/docs/sdd.md b/Svc/CmdSplitter/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcCmdSplitter Svc::CmdSplitter Component
 # Svc::CmdSplitter Component
 
 ## 1. Introduction

diff --git a/Svc/ComQueue/docs/sdd.md b/Svc/ComQueue/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcComQueueComponent Svc::ComQueue Component
 # Svc::ComQueue (Active Component)
 
 ## 1. Introduction

diff --git a/Svc/ComStub/docs/sdd.md b/Svc/ComStub/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcComStubComponent Svc::ComStub Component
 # Svc::ComStub (Passive Component)
 
 ## 1. Introduction

diff --git a/Svc/Deframer/docs/sdd.md b/Svc/Deframer/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcDeframerComponent Svc::Deframer Component
 # Svc::Deframer (Passive Component)
 
 ## 1. Introduction
@@ -95,9 +94,7 @@ SVC-DEFRAMER-011 | `Svc::Deframer` shall operate nominally when its port for sen
 
 The diagram below shows the `Deframer` component.
 
-<div>
-<img src="img/Deframer.png" width=700/>
-</div>
+![Deframer](img/Deframer.png)
 
 ### 4.2. Ports
 
@@ -349,24 +346,18 @@ optional.
 
 **Topology 1a: Buffers containing framed data (active byte stream driver):**
 
-<div>
-<img src="img/top/framed-active.png" width=1000/>
-</div>
+![active](img/top/framed-active.png)
 
 **Topology 1b: Buffers containing framed data (passive byte stream driver):**
 
-<div>
-<img src="img/top/framed-passive.png" width=1000/>
-</div>
+![passive](img/top/framed-passive.png)
 
 Revise the port number of `rateGroup.RateGroupMemberOut` as
 appropriate for your application.
 
 **Topology 2: Command packets and command responses:**
 
-<div>
-<img src="img/top/cmd.png" width=800/>
-</div>
+![cmd](img/top/cmd.png)
 
 Revise the port numbers of `cmdDisp.seqCmdBuff` and
 `cmdDisp.compCmdStat` as appropriate for your application.
@@ -375,9 +366,7 @@ assign these numbers.
 
 **Topology 3: Buffers containing packet data:**
 
-<div>
-<img src="img/top/deframer-file.png" width=1000/>
-</div>
+![file](img/top/deframer-file.png)
 
 ### 6.2. Sequence Diagrams
 
@@ -507,17 +496,13 @@ instance `hub` of type `Svc::GenericHub`.
 
 **Topology 2: Command packets**
 
-<div>
-<img src="img/top/hub-cmd.png" width=800/>
-</div>
+![hub-cmd](img/top/hub-cmd.png)
 
 Revise the port number of `hub.portIn` as appropriate for your application.
 
 **Topology 3: Buffers containing packet data**
 
-<div>
-<img src="img/top/hub-file.png" width=1000/>
-</div>
+![file](img/top/hub-file.png)
 
 Revise the port number of `hub.buffersIn` as appropriate for your application.
 When `hub` receives a buffer on `buffersIn`, it copies the data across

diff --git a/Svc/DpCatalog/docs/sdd.md b/Svc/DpCatalog/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcDpCatalogComponent Svc::DpCatalog Component
 # Svc::DpCatalog Component
 
 ## 1 Introduction

diff --git a/Svc/DpManager/docs/sdd.md b/Svc/DpManager/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcDpManagerComponent Svc::DpManager Component
 # Svc::DpManager (Active Component)
 
 ## 1. Introduction
@@ -22,7 +21,7 @@ It does the following:
 client components.
 Upon receiving a buffer, send the buffer out on a port.
 Another component such as
-[`Svc::BufferAccumulator`](../../BufferAccumulator/docs/BufferAccumulator.md)
+[`Svc::BufferAccumulator`](../../BufferAccumulator/docs/sdd.md)
 or [`Svc::DpWriter`](../../DpWriter/docs/sdd.md)
 will process the buffer and then send it back to the buffer manager
 for deallocation.
@@ -42,9 +41,7 @@ SVC-DPMANAGER-004 | `Svc::DpManager` shall provide telemetry that reports the nu
 
 The diagram below shows the `DpManager` component.
 
-<div>
-<img src="img/DpManager.png" width=700/>
-</div>
+![DpManager](img/DpManager.png)
 
 ### 3.2. Ports
 
@@ -197,21 +194,16 @@ connections.
 
 #### 5.1.1. Synchronously Getting Data Product Buffers
 
-<div>
-<img src="img/top/buffer-get.png" width=800/>
-</div>
+![Buffer Get](img/top/buffer-get.png)
 
 #### 5.1.2. Asynchronously Requesting Data Product Buffers
 
-<div>
-<img src="img/top/buffer-request.png" width=800/>
-</div>
+![Buffer Request](img/top/buffer-request.png)
+
 
 #### 5.1.3. Sending Data Products
 
-<div>
-<img src="img/top/product-send.png" width=1000/>
-</div>
+![Product Send](img/top/product-send.png)
 
 ### 5.2. Sequence Diagrams
 

diff --git a/Svc/DpWriter/docs/sdd.md b/Svc/DpWriter/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcDpWriterComponent Svc::DpWriter Component
 # Svc::DpWriter (Active Component)
 
 ## 1. Introduction
@@ -12,7 +11,7 @@ data products.
 They typically pass through an instance of
 [`Svc::DpManager`](../../DpManager/docs/sdd.md), and possibly through
 an instance of
-[`Svc::BufferAccumulator`](../../BufferAccumulator/docs/BufferAccumulator.md),
+[`Svc::BufferAccumulator`](../../BufferAccumulator/docs/sdd.md),
 before reaching `DpWriter`.
 
 1. For each buffer _B_ received in step 1:
@@ -43,9 +42,7 @@ SVC-DPWRITER-006 | `Svc::DpManager` shall provide telemetry that reports the num
 
 The diagram below shows the `DpWriter` component.
 
-<div>
-<img src="img/DpWriter.png" width=700/>
-</div>
+![DpWriter](img/DpWriter.png)
 
 ### 3.2. Ports
 
@@ -206,9 +203,7 @@ The diagrams use the following instances:
 
 * `producer`: A component that produces data products.
 
-<div>
-<img src="img/top/product-write.png" width=800/>
-</div>
+![product-write](./img/top/product-write.png)
 
 ### 6.2. Sequence Diagrams
 

diff --git a/Svc/Fatal/docs/sdd.md b/Svc/Fatal/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcFatalPort Svc::Fatal Port
 # Svc::Fatal Port
 
 ## 1. Introduction

diff --git a/Svc/FatalHandler/docs/sdd.md b/Svc/FatalHandler/docs/sdd.md
@@ -1,4 +1,3 @@
-\page SvcFatalHandlerComponent Svc::FatalHandler Component
 # Svc::FatalHandler Component
 
 ## 1. Introduction
Original file line number	Diff line number	Diff line change
		@@ -1,4 +1,3 @@
		\page SvcBufferAccumulatorComponent Svc::BufferAccumulator Component
		# BufferAccumulator Component Dictionary


Expand Down