F´ User Cheatsheet

[thomas-bc]

A number of software libraries/framework/etc. have what one could call a "cheatsheet".

This is a very short document, usually one to two pages long, where a lot of information is crammed in a single space about any and all information that's useful for a user, especially in the early stages of learning. This also helps with laying out a broad overview of all the notions and capabilities offered by the software (I often find myself discovering new features browsing through them).

A few examples:

• Pandas https://pandas.pydata.org/Pandas_Cheat_Sheet.pdf (this one is very visual, lots of diagrams)
• Docker https://docs.docker.com/get-started/docker_cheatsheet.pdf

Do we think this could be useful for the F´ community?
Some type of information that I'm thinking we could capture would include, off the top of my head:

• Send an event: log_<SEVERITY>_<EVENT_NAME>(arg)
• Write telemetry: tlmWrite_<TLM_NAME>(arg)
• get/set param: ....
• calling a port
• Useful Fw types and how to use them
• Useful Svc components and how to
• Useful CMake things
• Diagrams about a bunch of things...?
• options and commands for fprime-gds and fprime-util

Those are all things that become a habit as experience with the framework grows - but still could be beneficial to lay it all out somewhere just in case... and would also greatly help (in my opinion) with learning.

What do we think? 🚀
If we think it's useful, let's start drafting out a list of all the things we think should be in there!
This would vastly benefit from being community driven!

[thomas-bc]

This would for example be a great resource to print out during our workshops, instead of having students copy/paste the diverse function calls without needing to read through them

Could break out sections:

• C++ development
• Framework concepts Fw objects Svc components
• CMake
• fprime-gds / fprime-util

[LeStarch]

This sounds like a great idea!

[kevin-f-ortega]

Maybe include the different port (sync, guarded, async) and component (active, passive, queued) types.

[keck-in-space]

Man I would love something like this. I was just talking about this with coworker. What would also be nice is a full API surface document like this for some of the services. It can be hard to tell what all is available with the current docs, unless I'm missing something.