[Docs] MicroStrain driver documentation

[JoelJ18]

Documentation for MicroStrain Inertial Sensors
Related pull request:

• Adding driver for MicroStrain Inertial Sensors #23858

[hamishwillee]

Can you run prettier on the file and rebase - which may fix the listed flaws. I'd do it myself but you have not opened the PR to edits by maintainers>

Also add a link to your doc in the parent INS doc.

[JoelJ18]

Can you run prettier on the file and rebase - which may fix the listed flaws. I'd do it myself but you have not opened the PR to edits by maintainers>

Also add a link to your doc in the parent INS doc.

Didn't seem to work, I think you should have write access now though

[hamishwillee]

Didn't seem to work, I think you should have write access now though

Yes I do. Thanks.
So the flaws are mostly being reported by the internal link checker. It is expecting to see MS_SENSOR_YAW definitions in https://docs.px4.io/main/en/advanced_config/parameter_reference.html that aren't there. It may be that they haven't been built yet or it may be that they are being omitted because the driver isn't in default firmware.

Either is a bug on me at this point IFF those are the correct IDs for parameters added by your module. Can you just scan the list and make sure none are outside of your module and/or name typos.

These two might be unsupported formats for links.

LinkedInternalPageMissing: This linked file is missing: <(../advanced_config/parameter_reference.md
LinkedInternalPageMissing: This linked file is missing: <(../advanced_config/parameter_reference.md

I'll look at this again early next week.

[JoelJ18]

Yes I do. Thanks. So the flaws are mostly being reported by the internal link checker. It is expecting to see MS_SENSOR_YAW definitions in https://docs.px4.io/main/en/advanced_config/parameter_reference.html that aren't there. It may be that they haven't been built yet or it may be that they are being omitted because the driver isn't in default firmware.

So I used make parameters_metadata, and the parameters file is being generated in px4_stil_default/docs/modules.
All the parameters are generated in that file. I swapped that file with the one in en/advanced_config and viewed it using yarn.
All the links do seem to work. Apart from the two typos(LinkedInternalPageMissing) which I can change.
Is it too late to modify the module.yaml file that this is being generated from? Id like to make a few changes for readability

[hamishwillee]

Cool.

Is it too late to modify the module.yaml file that this is being generated from? Id like to make a few changes for readability

No. You can always go back and fix up any module.

[hamishwillee]

For all these, my understanding is that you need to use the right field to indicate restart required

            reboot_required: true

For example https://github.com/PX4/PX4-Autopilot/blob/main/src/drivers/actuators/vertiq_io/module.yaml#L248

So I'd make that change and remove the text on rebooting

[JoelJ18]

Got it, I had assumed reboot_required meant the whole FC needed to be rebooted

[hamishwillee]

It does. But for most users they wouldn't (and shouldn't) know how to just reboot a driver. So its easier and safer just to tell them to reboot the whole thing.

[hamishwillee]

You could keep the text driver restart if you want. Let me know when you have updated.

@dakejahl Below are YAML changes. They make sense to me, but would be great to get an independent scan.

[hamishwillee]

Thanks @JoelJ18 . I'm back from holiday now. See comments - looking pretty close to me.

[JoelJ18]

Thanks @JoelJ18 . I'm back from holiday now. See comments - looking pretty close to me.

I'm working on another PR to add some features to the driver, so will be expanding the documentation for that. Can this be held off till I open the other PR and it gets merged?

[hamishwillee]

I'm working on another PR to add some features to the driver, so will be expanding the documentation for that. Can this be held off till I open the other PR and it gets merged?

Sure, note that their are conflicts too.

[JoelJ18]

Updated wrt #25673
I made all the yaml changes in that PR, so i think i can revert it back here?

[hamishwillee]

Thanks @JoelJ18 - Looks great. All the flaws have gone since I rebased on the version which has the parameters.

[github-actions]

No flaws found