Revise User's Guide

Addresses #571

Author: bocchino

docs/fpp-spec.html

@@ -10582,7 +10582,7 @@ <h3 id="Analysis-and-Translation_Translation-Tools">22.4. Translation Tools</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-12-11 16:51:10 -0800
+Last updated 2025-01-16 09:31:29 -0800
 </div>
 </div>
 <script src="code-prettify/run_prettify.js"></script>

docs/fpp-users-guide.html

@@ -756,7 +756,7 @@ <h2 id="Introduction">1. Introduction</h2>
 SmallSat 2018</a>
 provides an overview of F Prime.
 For more detailed information about F Prime, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.</p>
 </div>
 <div class="paragraph">
 <p>The goals of FPP are as follows:</p>
@@ -3635,8 +3635,8 @@ <h3 id="Defining-State-Machines_Writing-a-State-Machine-Definition">9.1. Writing
 of FPP state machines.
 For more details about the C&#43;&#43; code generation
 for state machines, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime design
-documentation</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/state-machines/">F
+Prime design documentation</a>.</p>
 </div>
 </div>
 <div class="sect2">
@@ -5794,7 +5794,7 @@ <h4 id="Defining-Components_Port-Instances_Basic-Port-Instances">10.2.1. Basic P
 base class with a virtual handler function, and then override that virtual
 function in a derived class that you write.
 For further details about implementing F Prime components, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.</p>
 </div>
 <div class="paragraph">
 <p><strong>Note on terminology:</strong> As explained above, there is a technical
@@ -6089,7 +6089,7 @@ <h4 id="Defining-Components_Port-Instances_Serial-Port-Instances">10.2.6. Serial
 This flexibility comes at the cost that you lose the type
 compile-time type checking provided by port connections with named types.
 For more information about serial ports and their use, see
-the <a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
+the <a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.</p>
 </div>
 </div>
 </div>
@@ -6228,7 +6228,7 @@ <h4 id="Defining-Components_Special-Port-Instances_Command-Ports">10.3.1. Comman
 <div class="paragraph">
 <p>For further information about command registration, receipt, and
 response, and implementing command handlers, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.</p>
 </div>
 </div>
 <div class="sect3">
@@ -6309,7 +6309,7 @@ <h4 id="Defining-Components_Special-Port-Instances_Event-Ports">10.3.2. Event Po
 </div>
 <div class="paragraph">
 <p>For further information about events in F Prime, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.</p>
 </div>
 </div>
 <div class="sect3">
@@ -6358,7 +6358,7 @@ <h4 id="Defining-Components_Special-Port-Instances_Telemetry-Ports">10.3.3. Tele
 </div>
 <div class="paragraph">
 <p>For further information about telemetry in F Prime, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.</p>
 </div>
 </div>
 <div class="sect3">
@@ -6443,7 +6443,7 @@ <h4 id="Defining-Components_Special-Port-Instances_Parameter-Ports">10.3.4. Para
 </div>
 <div class="paragraph">
 <p>For further information about parameters in F Prime, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.</p>
 </div>
 </div>
 <div class="sect3">
@@ -6493,7 +6493,7 @@ <h4 id="Defining-Components_Special-Port-Instances_Time-Get-Ports">10.3.5. Time
 </div>
 <div class="paragraph">
 <p>For further information about time in F Prime, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.</p>
 </div>
 </div>
 <div class="sect3">
@@ -6616,8 +6616,8 @@ <h4 id="Defining-Components_Special-Port-Instances_Data-Product-Ports">10.3.6. D
 </div>
 <div class="paragraph">
 <p>For further information about data products in F Prime, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/design/data-products/">data
-products documentation</a> in the F Prime repository.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/data-products/">F
+Prime design documentation</a>.</p>
 </div>
 </div>
 </div>
@@ -6761,7 +6761,7 @@ <h3 id="Defining-Components_Commands">10.5. Commands</h3>
 <div class="paragraph">
 <p>For complete information about F Prime command dispatch and
 handling, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.
 Here we concentrate on how to specify commands in FPP.</p>
 </div>
 <div class="sect3">
@@ -7124,7 +7124,7 @@ <h3 id="Defining-Components_Events">10.6. Events</h3>
 <div class="paragraph">
 <p>For complete information about F Prime event
 handling, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.
 Here we concentrate on how to specify events in FPP.</p>
 </div>
 <div class="sect3">
@@ -7423,7 +7423,7 @@ <h4 id="Defining-Components_Events_Throttling">10.6.4. Throttling</h4>
 emit the event until the throttling is canceled.
 Typically, the canceling happens via a FSW command.
 For details, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.</p>
 </div>
 </div>
 </div>
@@ -7444,7 +7444,7 @@ <h3 id="Defining-Components_Telemetry">10.7. Telemetry</h3>
 <div class="paragraph">
 <p>For complete information about F Prime telemetry
 handling, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.
 Here we concentrate on how to specify telemetry channels in FPP.</p>
 </div>
 <div class="sect3">
@@ -7804,7 +7804,7 @@ <h3 id="Defining-Components_Parameters">10.8. Parameters</h3>
 database component for storing parameters in a non-volatile
 manner (e.g., on a file system).
 For complete information about F Prime parameters, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime User Manual</a>.
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F Prime User Manual</a>.
 Here we concentrate on how to specify parameters in FPP.</p>
 </div>
 <div class="sect3">
@@ -8135,8 +8135,8 @@ <h3 id="Defining-Components_Data-Products">10.9. Data Products</h3>
 (2) writing data products to the file system; and (3)
 cataloging stored data products for downlink in priority order.
 For more information about these F Prime features, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime data
-products documentation</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/data-products/">F
+Prime design documentation</a>.</p>
 </div>
 <div class="sect3">
 <h4 id="Defining-Components_Data-Products_Basic-Data-Products">10.9.1. Basic Data Products</h4>
@@ -8149,8 +8149,8 @@ <h4 id="Defining-Components_Data-Products_Basic-Data-Products">10.9.1. Basic Dat
 representing a list of serialized <strong>records</strong>.
 A record is a unit of data.
 For a complete specification of the container format, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/reference/api/cpp/html/_fw_dp.html">documentation</a>
-on F Prime framework support for data products.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/reference/sdd/Fw/Dp/docs/sdd/">F
+Prime design documentation</a>.</p>
 </div>
 <div class="paragraph">
 <p>In an F Prime component, you can specify one or more containers
@@ -8215,8 +8215,8 @@ <h4 id="Defining-Components_Data-Products_Basic-Data-Products">10.9.1. Basic Dat
 <p>The FPP back end uses this specification to generate code for requesting
 buffers to hold containers and for serializing records into containers.
 See the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/design/data-products/">F
-Prime data products documentation</a> for the details.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/data-products/">F
+Prime design documentation</a> for the details.</p>
 </div>
 <div class="paragraph">
 <p>Note the following:</p>
@@ -8456,8 +8456,8 @@ <h3 id="Defining-Components_State-Machine-Instances">10.10. State Machine Instan
 machine definitions may be internal (specified in FPP) or external (specified
 by an external tool).  For more details about the C&#43;&#43; code generation for
 instances of internal state machines, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F Prime design
-documentation</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/state-machines/">F
+Prime design documentation</a>.</p>
 </div>
 </div>
 <div class="sect2">
@@ -12988,13 +12988,13 @@ <h4 id="Analyzing-and-Translating-Models_Generating-C-Plus-Plus_Types-Ports-Stat
 <div class="paragraph">
 <p>Once you generate C&#43;&#43; code for these definitions, you can use it to
 write a flight software implementation.
-The <a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F
+The <a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F
 User Manual</a> explains how to do this.</p>
 </div>
 <div class="paragraph">
 <p>For more information about the generated code for data products,
 for state machines, and for state machine instances, see the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/state-machines/">F
 Prime design documentation</a>.</p>
 </div>
 </div>
@@ -13006,7 +13006,7 @@ <h4 id="Analyzing-and-Translating-Models_Generating-C-Plus-Plus_Component-Implem
 partial implementations and for generating unit test code.
 Here we cover the mechanics of using these options.
 For more information on implementing and testing components in F Prime, see
-the <a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/">F
+the <a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/">F
 Prime User Manual</a>.</p>
 </div>
 <div class="paragraph">
@@ -13982,8 +13982,8 @@ <h3 id="Analyzing-and-Translating-Models_Generating-Ground-Dictionaries">14.8. G
 <em>T</em> <code>TopologyDictionary.json</code>.
 The dictionary is specified in JavaScript Object Notation (JSON) format.
 The JSON format is specified in the
-<a href="https://fprime.jpl.nasa.gov/latest/documentation/user-manual/design/fpp-json-dict/">F
-Prime dictionary documentation</a>.</p>
+<a href="https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/fpp-json-dict/">F
+Prime design documentation</a>.</p>
 </div>
 <div class="paragraph">
 <p>Here is a common use case:</p>
@@ -14817,7 +14817,7 @@ <h4 id="Writing-C-Plus-Plus-Implementations_Implementing-Deployments_Public-Symb
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-12-11 16:51:28 -0800
+Last updated 2025-01-16 09:31:14 -0800
 </div>
 </div>
 <script src="code-prettify/run_prettify.js"></script>

docs/users-guide/Analyzing-and-Translating-Models.adoc

@@ -566,12 +566,12 @@ uses the name `A_B_CComponentAc_HPP` in its include guard.
 
 Once you generate {cpp} code for these definitions, you can use it to
 write a flight software implementation.
-The https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F
+The https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F
 User Manual] explains how to do this.
 
 For more information about the generated code for data products,
 for state machines, and for state machine instances, see the
-https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F
+https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/state-machines/[F
 Prime design documentation].
 
 ==== Component Implementation and Unit Test Code
@@ -581,7 +581,7 @@ or
 partial implementations and for generating unit test code.
 Here we cover the mechanics of using these options.
 For more information on implementing and testing components in F Prime, see
-the https://fprime.jpl.nasa.gov/latest/documentation/user-manual/[F
+the https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F
 Prime User Manual].
 
 *Generating implementation templates:*
@@ -1361,8 +1361,8 @@ file
 _T_ `TopologyDictionary.json`.
 The dictionary is specified in JavaScript Object Notation (JSON) format.
 The JSON format is specified in the
-https://fprime.jpl.nasa.gov/latest/documentation/user-manual/design/fpp-json-dict/[F 
-Prime dictionary documentation].
+https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/fpp-json-dict/[F 
+Prime design documentation].
 
 Here is a common use case: