Skip to content

Website update: How-To Organization, Automated Landing Pages#5328

Open
Specky26846 wants to merge 44 commits into
nasa:develfrom
Specky26846:zensical-integ
Open

Website update: How-To Organization, Automated Landing Pages#5328
Specky26846 wants to merge 44 commits into
nasa:develfrom
Specky26846:zensical-integ

Conversation

@Specky26846

@Specky26846 Specky26846 commented Jun 24, 2026

Copy link
Copy Markdown
Contributor
Related Issue(s)
Has Unit Tests (y/n) n
Documentation Included (y/n) y
Generative AI was used in this contribution (y/n) y

Change Description

Running PR of all changes made throughout Zensical integration process. We are no longer migrating the entire website over to Zensical, but some upgrades were still able to be folded into the current MkDocs configuration. The number of files changed is high due to the rearranging of folders for the documentation.

  • Reorganization of the How-To guides into subfolders
  • Automated landing pages that will update when new documentation is added

Rationale

This is a derivative of the Zensical integration. While Zensical was not mature enough as of June 2026 to fully migrate the F Prime website, certain upgrades can still be folded into the MkDocs version.

Testing/Review Recommendations

Changes were tested using the Jenkins UAT site.

Future Work

  • Documentation website separation (reordering of tabs, move main doc sections to the header)

AI Usage (see policy)

AI used to debug Python scripts or adapt them from one folder to another. Also used to troubleshoot Jenkins issues.

@Specky26846 Specky26846 changed the title Zensical integration fprime/docs changes Documentation update: How-To Organization, Automated Landing Pages, Reordered Tabs Jul 1, 2026
@Specky26846 Specky26846 marked this pull request as ready for review July 7, 2026 23:44
@Specky26846 Specky26846 changed the title Documentation update: How-To Organization, Automated Landing Pages, Reordered Tabs Website update: How-To Organization, Automated Landing Pages, Reordered Tabs Jul 8, 2026
LeStarch
LeStarch previously approved these changes Jul 8, 2026
@Specky26846 Specky26846 changed the title Website update: How-To Organization, Automated Landing Pages, Reordered Tabs Website update: How-To Organization, Automated Landing Pages Jul 8, 2026
LeStarch
LeStarch previously approved these changes Jul 8, 2026
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Coverage report — base devel

Overall (line): 82.01% → 81.41% (-0.60)
Regression threshold: 0.50% (line).

Regressions

(none over threshold)

Modules changed

Module Line Δ Function Δ Branch Δ
Fw/DataStructures 98.21 -0.27 96.95 +0.00 82.84 -0.37
Os/Generic 89.10 -0.06 96.30 +8.14 67.18 -5.68
Os/Generic/Types 92.45 +0.06 91.67 -1.19 82.14 +7.85
Os 17.98 +3.15 19.40 +1.76 14.47 +2.82

Modules without UTs

CFDP/Checksum/GTest, Drv/ByteStreamDriverModel, Drv/Interfaces, Drv/LinuxGpioDriver, Drv/LinuxI2cDriver, Drv/LinuxSpiDriver, Drv/LinuxUartDriver, Drv/Ports, Drv/Ports/DataTypes, FppTestProject/FppTest/interfaces, FppTestProject/FppTest/topology/async, FppTestProject/FppTest/topology/components/Comp, FppTestProject/FppTest/topology/components/Framework, FppTestProject/FppTest/topology/components/Receiver, FppTestProject/FppTest/topology/components/Sender, FppTestProject/FppTest/topology/guarded, FppTestProject/FppTest/topology/ports, FppTestProject/FppTest/topology/sync, FppTestProject/FppTest/topology/top_ports, FppTestProject/FppTest/topology/types, Fw/Cmd, Fw/Com, Fw/Comp, Fw/FilePacket/GTest, Fw/Fpy, Fw/Interfaces, Fw/Obj, Fw/Port, Fw/Ports/CompletionStatus, Fw/Ports/Ready, Fw/Ports/Signal, Fw/Ports/SuccessCondition, Fw/Prm, Fw/SerializableFile/test/TestSerializable, Fw/Sm, Fw/Test, Fw/Types/GTest, Os/Models, Svc/Cycle, Svc/DpPorts, Svc/Fatal, Svc/FatalHandler, Svc/FileDownlinkPorts, Svc/FprimeProtocol, Svc/Interfaces, Svc/PassiveConsoleTextLogger, Svc/Ping, Svc/PolyIf, Svc/Ports/CommsPorts, Svc/Ports/FilePorts, Svc/Ports/OsTimeEpoch, Svc/Ports/TlmPacketizerPorts, Svc/Ports/VersionPorts, Svc/Sched, Svc/Seq, Svc/Subtopologies/CdhCore, Svc/Subtopologies/ComCcsds, Svc/Subtopologies/ComFprime, Svc/Subtopologies/ComLoggerTee, Svc/Subtopologies/DataProducts, Svc/Subtopologies/FileHandling, Svc/Types/TlmPacketizerTypes, Svc/WatchDog, TestDeploymentsProject/Ref/PingReceiver, TestDeploymentsProject/Ref/RecvBuffApp, TestDeploymentsProject/Ref/SendBuffApp, TestDeploymentsProject/Ref/Top, TestDeploymentsProject/Ref/TypeDemo, cmake/test/data/TestDeployment/TestBuildAutocoder, cmake/test/data/TestDeployment/TestChainedAutocoder, cmake/test/data/TestDeployment/TestHeaderAutocoder, cmake/test/data/TestDeployment/TestTargetAutocoder, cmake/test/data/test-fprime-library/TestLibrary/TestComponent, cmake/test/data/test-fprime-library2/TestLibrary2/TestComponent

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants