Skip to content

Commit 4bd297a

Browse files
authored
Add docs for How-To Write Rule-Based Tests (#5052)
* initial document * Improved how-to docs * Add missing cards to how-to/index.md * nits * add tips * fix spelling * typo
1 parent d86b54d commit 4bd297a

2 files changed

Lines changed: 476 additions & 0 deletions

File tree

docs/how-to/index.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,93 @@ How-To guides offer step-by-step instructions for specific development tasks in
4343

4444
[View Porting Guide](porting-guide.md){ .md-button .md-button--primary }
4545

46+
47+
- <span class="card-title">__Implement a Framing Protocol__</span>
48+
49+
---
50+
51+
This guide shows you how to implement a custom framing protocol in F Prime flight software and integrate it with the F Prime GDS.
52+
53+
[View Implement a Framing Protocol](custom-framing.md){ .md-button .md-button--primary }
54+
55+
- <span class="card-title">__Generate Data Products__</span>
56+
57+
---
58+
59+
This guide shows you when to use data products, how to generate them, how to test them, and how to integrate them into your topology and ground system.
60+
61+
[View Generate Data Products](data-products.md){ .md-button .md-button--primary }
62+
63+
- <span class="card-title">__Define State Machines__</span>
64+
65+
---
66+
67+
This guide shows you how to define and use state machines in F Prime with FPP so complex component behavior is explicit, testable, and maintainable.
68+
69+
[View Define State Machines](define-state-machines.md){ .md-button .md-button--primary }
70+
71+
- <span class="card-title">__Create Ground-Derived Channels__</span>
72+
73+
---
74+
75+
This guide shows you how to compute telemetry-derived values on the ground and publish them through the F Prime GDS plugin system.
76+
77+
[View Create Ground-Derived Channels](derive-channels-on-ground.md){ .md-button .md-button--primary }
78+
79+
- <span class="card-title">__Develop a Device Driver__</span>
80+
81+
---
82+
83+
This guide shows you how to build a new device driver in F Prime using the application-manager-driver pattern.
84+
85+
[View Develop a Device Driver](develop-device-driver.md){ .md-button .md-button--primary }
86+
87+
- <span class="card-title">__Develop a Subtopology__</span>
88+
89+
---
90+
91+
This guide shows you how to organize reusable topology architecture into subtopologies that can be imported into deployments.
92+
93+
[View Develop a Subtopology](develop-subtopologies.md){ .md-button .md-button--primary }
94+
95+
- <span class="card-title">__Implement an OS Abstraction Layer__</span>
96+
97+
---
98+
99+
This guide shows you how to implement a new OS Abstraction Layer for F´ so the framework can run on another operating system.
100+
101+
[View Implement an OS Abstraction Layer](implement-osal.md){ .md-button .md-button--primary }
102+
103+
- <span class="card-title">__Implement a Radio Manager Component__</span>
104+
105+
---
106+
107+
This guide shows you how to implement a radio manager component using the communications adapter interface.
108+
109+
[View Implement a Radio Manager Component](implement-radio-manager.md){ .md-button .md-button--primary }
110+
111+
- <span class="card-title">__Develop Components in Python__</span>
112+
113+
---
114+
115+
This guide shows you how to develop Python-based F Prime applications and integrate Python components into a larger system.
116+
117+
[View Develop Components in Python](python-development.md){ .md-button .md-button--primary }
118+
119+
- <span class="card-title">__Write Rule-Based Tests__</span>
120+
121+
---
122+
123+
This guide shows you how to write rule-based unit tests for F Prime components using the RuleDemo example component.
124+
125+
[View Write Rule-Based Tests](rule-based-testing.md){ .md-button .md-button--primary }
126+
127+
- <span class="card-title">__Test-Driven Development__</span>
128+
129+
---
130+
131+
This guide shows you a practical test-driven development loop for building an F´ component from model to implementation.
132+
133+
[View Test-Driven Development](test-driven-development.md){ .md-button .md-button--primary }
134+
46135
</div>

0 commit comments

Comments
 (0)