Skip to content

Comments

docs: Markup board specific parameters#26527

Open
hamishwillee wants to merge 3 commits intomainfrom
docs_params_mark_board_specific_params
Open

docs: Markup board specific parameters#26527
hamishwillee wants to merge 3 commits intomainfrom
docs_params_mark_board_specific_params

Conversation

@hamishwillee
Copy link
Contributor

This updates the parameter reference markdown output script to allow notes to be added to each parameter that is board-specific. You can either specify a group by name and apply the note to all parameters in the group, or specify particular parameters.

In this version the note is added to all parameters in "Actuator Outputs" group.

The note looks like this.

image

This comes from a discussion with @sfuhrer

@hamishwillee hamishwillee requested a review from sfuhrer February 19, 2026 01:51
Signed-off-by: Silvan <silvan@auterion.com>
@sfuhrer
Copy link
Contributor

sfuhrer commented Feb 19, 2026

image The info field is rather a bit large. Adds a lot of space to the docs. I would make it more discrete (lake a label, not a full info box, if possible), and otherwise would actually only add the info to the PWM_TIMx params. It's more hidden that some boards have different output pins associated with specific timer groups. While it's easy to see that some boards have only e.g. MAIN.

@hamishwillee
Copy link
Contributor Author

@sfuhrer Thanks. To address your concerns about layout turned the note into a heading badge like this (ignore where they are applied - that was just to test rendering)

image

@sfuhrer
Copy link
Contributor

sfuhrer commented Feb 20, 2026

@sfuhrer Thanks. To address your concerns about layout turned the note into a heading badge like this (ignore where they are applied - that was just to test rendering)

Yes that looks great!

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