Add documentation regarding code generation guidelines - Stint 1

[mfussi66]

Now that we have achieved some sort of expertise regarding code generation for an embedded board, it might be nice to create a .md document that highlights the best practices and settings to apply for an effective and flexible process.

For example, it could contain:

• Simulink model settings
• CMSIS settings
• Best practices for Simulink blocks
• Stateflow guidelines
• a sprinkle of dictionary usage

05/07/2024 Update:
Adding a checklist of the points addressed in this Stint 1

• Introduction and Setup of application and toolboxes
• Model configuration parameters
• Setting up code replacement libraries and CMSIS

[pattacini]

Nice idea @mfussi66 👍🏻

However, the goal is to publish everything, including these aspects related to the policies, on our website; so, in this sense, it's very much related to:

• Complete the online documentation of the models underlying the new electronic boards #13

Now that we're in a good position with the development of the architectural models, we can think of addressing the public documentation from the ground up.

Probably, we should put this on the bill for the next facility increment.

[pattacini]

Well, we haven't covered the proper Software Architectures yet...
Something that we have definitely to keep in mind.

[pattacini]

/remind May 06

[octo-reminder]

⏰ Reminder
Monday, May 6, 2024 10:00 AM (GMT+02:00)

[octo-reminder]

🔔 @pattacini

[mfussi66]

Started a draft in my fork: https://github.com/mfussi66/icub-firmware-models/blob/devel/boards/docs/The%20Techie's%20guide%20to%20code%20generation.md

[pattacini]

Great!

Agreed F2F that we eventually aim to develop the website.
In the meantime, we can keep on collecting useful info as markdown files.

[mfussi66]

At the moment I am at the Code generation part of the model configuration parameters: https://github.com/mfussi66/icub-firmware-models/blob/devel/boards/docs/The%20Techie's%20guide%20to%20code%20generation.md#code-generation

[mfussi66]

In this commit, I think I concluded the draft for the Configuration Parameters window: https://github.com/mfussi66/icub-firmware-models/tree/acc4d9da907b1f4e47e525eedcf1c9d03629a18c

There is also a small section that talks about code replacement libraries with a link to the official docs.

[pattacini]

Well done 👍🏻
I'm a bit overwhelmed these days. I'll try to catch up soon.

[mfussi66]

Well done 👍🏻 I'm a bit overwhelmed these days. I'll try to catch up soon.

No problem! Just posting regular updates to show progress on the task.

[mfussi66]

Given the scope of the task, maybe it will be useful to swtich this issue to a first stint?

cc @pattacini

[pattacini]

Good point 👍🏻

I've turned #13 into an Epic and thus associated this issue with that Epic.
Feel free to close this task as complete and open a follow-up to be bundled to the Epic.

[mfussi66]

Closing in favour of follow up #93.

[mfussi66]

I updated the open post with a checklist of topics addressed in this first sprint @andreaderito .