Merge pull request #589 from bosh/config_guide_links

bosh · web-flow · commit 6b6ec0c3c76b · 2025-04-08T16:48:17.000-07:00
add missing "Related How To guide" sections for config pages
diff --git a/docs/config/blinkenlights.md b/docs/config/blinkenlights.md
@@ -171,8 +171,7 @@ Name of this device in service mode.
 List of one (or more) values, each is a type: `string`. Defaults to
 empty.
 
---8<-- "todo.md"
 
 ## Related How To guides
 
---8<-- "todo.md"
+* [Blinkenlight player](../config_players/blinkenlight_player.md)
diff --git a/docs/config/bonus.md b/docs/config/bonus.md
@@ -188,3 +188,7 @@ This is nice if you don't want a bonus screen to show up for something
 the player has not done, like "0 ramps = 0 points" or whatever. (Or
 maybe you want to make this "true" to show the player how bad they
 are?) :)
+
+## Related How To guides
+
+* [How to configure End of Ball Bonus](../game_logic/bonus/configuring_bonus.md)
diff --git a/docs/config/credits.md b/docs/config/credits.md
@@ -300,3 +300,7 @@ versus specials versus high score awards, etc.
 ### award:
 
 Numeric value of the number of credits you'd like to award.
+
+## Related How To guides
+
+* [Coins & Credits](../game_logic/credits.md)
diff --git a/docs/config/logic_blocks.md b/docs/config/logic_blocks.md
@@ -24,9 +24,14 @@ counters:
 
 There are three type of logic blocks:
 
+* [accruals:](accruals.md)
+* [counters:](counters.md)
+* [sequences:](sequences.md)
+
+Click each of the links above for details and settings for each type of logic block.
+
+## Related How To guides
+
 * [accruals:](../game_logic/logic_blocks/accruals.md)
 * [counters:](../game_logic/logic_blocks/counters.md)
 * [sequences:](../game_logic/logic_blocks/sequences.md)
-
-Click each of the links above for details and settings for each type of
-logic block.
diff --git a/docs/config/logic_blocks_common.md b/docs/config/logic_blocks_common.md
@@ -108,3 +108,9 @@ If `true` this device will start enabled. If `false` this device will
 start disabled. If you omit this the device will start enabled unless
 you specify `enable_events` in which case the device will start
 disabled.
+
+## Related How To guides
+
+* [accruals:](../game_logic/logic_blocks/accruals.md)
+* [counters:](../game_logic/logic_blocks/counters.md)
+* [sequences:](../game_logic/logic_blocks/sequences.md)
diff --git a/docs/config/named_colors.md b/docs/config/named_colors.md
@@ -45,4 +45,4 @@ light_player:
 
 ## Related How To guides
 
---8<-- "todo.md"
+* [Lights](../mechs/lights/index.md)
diff --git a/docs/config/opp_coils.md b/docs/config/opp_coils.md
@@ -28,3 +28,7 @@ The recycle_factor is used in OPP to determine the cool down time of a
 coil after a pulse in relation to default_pulse_ms. For instance, with
 recycle_factor of 2 and a default_pulse_ms of 20ms the coil will cool
 down for at least 40ms after each pulse.
+
+## Related How To guides
+
+* [OPP coils / drivers](../hardware/opp/drivers.md)
diff --git a/docs/config/pd_led_boards.md b/docs/config/pd_led_boards.md
@@ -308,3 +308,7 @@ Single value, type: `integer`. Default: `1603`
 
 Clock cycles for a reset bit in a WS281x chain (at 32MHz). Usually this
 does not have to be changed.
+
+## Related How To guides
+
+* [How to configure LEDs on the PD-LED (P-ROC/P3-ROC)](../hardware/multimorphic/leds.md)
diff --git a/docs/config/shot_profiles.md b/docs/config/shot_profiles.md
@@ -265,3 +265,7 @@ The step number the show will start on.
 Single value, type: `integer`. Default: `None`
 
 The sync_ms value of the show.
+
+## Related How To guides
+
+* [Shot Profiles](../game_logic/shots/shot_profiles.md)
diff --git a/docs/config/show_config.md b/docs/config/show_config.md
@@ -77,3 +77,8 @@ Single value, type: `integer`.
 
 See the [Synchronizing multiple shows](../shows/sync_ms.md) documentation for
 details.
+
+## Related How To guides
+
+* [Shows](../shows/index.md)
+* [Tutorial step 16: Create an attract mode display show](../tutorial/16_attract_mode_show.md)
diff --git a/docs/config/show_player.md b/docs/config/show_player.md
@@ -350,4 +350,6 @@ details.
 
 ## Related How To guides
 
---8<-- "todo.md"
+* [Shows](../shows/index.md)
+* [Tutorial step 16: Create an attract mode display show](../tutorial/16_attract_mode_show.md)
+* [Show player](../config_players/show_player.md)
diff --git a/docs/config/slide_player.md b/docs/config/slide_player.md
@@ -209,8 +209,6 @@ One or more sub-entries. Each in the format of `string` : `string`
 
 ### transition:
 
-Unknown type. See description below.
-
 Note that you can also configure a transition when the slide is defined
 in the [slides:](slides.md) section of your
 config if you want to use the same transition every time for a slide and
@@ -221,8 +219,6 @@ slide_player or show will take precedence.
 
 ### transition_out:
 
-Unknown type. See description below.
-
 Note that you can add a transition out to the slide player when a slide
 is shown, and it will be "attached" to the slide and used when that
 slide is removed (either with the slide player or when a new slide is
@@ -263,10 +259,9 @@ then the incoming transition will take precedence.
 
 ### widgets:
 
-Unknown type. See description below.
-
 --8<-- "todo.md"
 
 ## Related How To guides
 
---8<-- "todo.md"
+* [Slide player](../config_players/slide_player.md)
+* [Tutorial: Slide with Score, Player, and Ball](../gmc/guides/base-slide-with-score.md)
diff --git a/docs/config/slides.md b/docs/config/slides.md
@@ -194,10 +194,6 @@ it's not showing up.
 
 ### transition_out:
 
-Unknown type. See description below.
-
---8<-- "todo.md"
-
 Note that you can also configure a transition when the slide is shown
 (in either a show or via the slide_player), so you don't need to define
 a transition as part of the slide definition unless you want that
@@ -208,4 +204,4 @@ slide_player or show will take precedence.
 
 ## Related How To guides
 
---8<-- "todo.md"
+* [Slides](../mc/slides/index.md)
diff --git a/docs/config/sound_loop_player.md b/docs/config/sound_loop_player.md
@@ -377,3 +377,7 @@ Single value, type: `integer`.
 An integer value that specifies which layer number of the currently
 playing sound loop set should be stopped when the sound loop set master
 sound reaches the end. Layers are numbered beginning with 1.
+
+## Related How To guides
+
+* [Sound Loop player](../config_players/sound_loop_player.md)
diff --git a/docs/config/sound_loop_sets.md b/docs/config/sound_loop_sets.md
@@ -216,3 +216,7 @@ play state for the layer when the sound loop set is played. Options for
     playback.
 * `stop` - The layer will be stopped whenever the sound loop set
     begins playback.
+
+## Related How To guides
+
+* [Sounds, Music & Audio](../mc/sound/index.md)
diff --git a/docs/config/sound_pools.md b/docs/config/sound_pools.md
@@ -200,3 +200,7 @@ limit. This setting is ignored when `simultaneous_limit` is set to
     playing instance).
 * `skip` - Do not steal/stop any currently running instances of the
     sound. Simply skip playback of the newly requested instance.
+
+## Related How To guides
+
+* [Sounds, Music & Audio](../mc/sound/index.md)
diff --git a/docs/config/spinners.md b/docs/config/spinners.md
@@ -200,8 +200,6 @@ Name of this device in service mode.
 List of one (or more) values, each is a type: `string`. Defaults to
 empty.
 
---8<-- "todo.md"
-
 ## Related How To guides
 
---8<-- "todo.md"
+* [Spinners](../mechs/spinners.md)
diff --git a/docs/config/state_machines.md b/docs/config/state_machines.md
@@ -161,6 +161,8 @@ empty.
 
 Not used.
 
+## Related Config fields:
+
 * [state_machine_transitions:](state_machine_transitions.md)
 * [state_machine_states:](state_machine_states.md)
 
diff --git a/docs/config/step_stick_stepper_settings.md b/docs/config/step_stick_stepper_settings.md
@@ -41,3 +41,7 @@ How long should the digital output be held to low after a step pulse?
 This time depends on the latency/jitter of your output and the speed
 your stepper can be moved. Usually the jitter of your output is the
 limiting factor.
+
+## Related How To guides
+
+* [How to use Step Stick Steppers in MPF](../hardware/stepstick.md)
diff --git a/docs/config/switch_overwrites.md b/docs/config/switch_overwrites.md
@@ -29,3 +29,7 @@ Default: `None`
 
 Overwrite the `debounce` setting on a coil. See `debounce` in
 [switches:](switches.md) for details.
+
+## Related How To guides
+
+* [Switches](../mechs/switches/index.md)
diff --git a/docs/config/text_ui.md b/docs/config/text_ui.md
@@ -58,4 +58,4 @@ player variables will be displayed.
 
 ## Related How To guides
 
---8<-- "todo.md"
+* [Dynamically Updating Text](../mc/widgets/text/text_dynamic.md)
diff --git a/docs/config/tic_stepper_settings.md b/docs/config/tic_stepper_settings.md
@@ -22,30 +22,24 @@ The following sections are optional in the `tic_stepper_settings:`
 section of your config. (If you don't include them, the default will be
 used).
 
+--8<-- "todo.md"
+
 ### current_limit:
 
 Single value, type: `integer`. Default: `192`
 
---8<-- "todo.md"
-
 ### max_acceleration:
 
 Single value, type: `integer`. Default: `40000`
 
---8<-- "todo.md"
-
 ### max_deceleration:
 
 Single value, type: `integer`. Default: `40000`
 
---8<-- "todo.md"
-
 ### max_speed:
 
 Single value, type: `integer`. Default: `2000000`
 
---8<-- "todo.md"
-
 ### poll_ms:
 
 Single value, type: `time string (ms)`
@@ -59,14 +53,10 @@ this.
 
 Single value, type: `integer`. Default: `0`
 
---8<-- "todo.md"
-
 ### step_mode:
 
 Single value, type: `integer`. Default: `1`
 
---8<-- "todo.md"
-
 ## Related How To guides
 
 * [How to use Pololu Tic in MPF](../hardware/pololu_tic.md)
diff --git a/docs/config/virtual_segment_display_connector.md b/docs/config/virtual_segment_display_connector.md
@@ -38,8 +38,6 @@ does not need to be modified as the default value should be correct.
 
 Single value, type: `boolean` (`true`/`false`). Default: `false`
 
---8<-- "todo.md"
-
 ### segment_displays:
 
 List of one (or more) values, each is a type: string name of a
@@ -52,4 +50,4 @@ appropriate information to the MPF-MC.
 
 ## Related How To guides
 
---8<-- "todo.md"
+* [How to setup and use the virtual segment display emulator](../mc/widgets/segment_display_emulator/how_to.md)
diff --git a/docs/hardware/opp/drivers.md b/docs/hardware/opp/drivers.md
@@ -8,6 +8,7 @@ title: OPP coils / drivers
 Related Config File Sections:
 
 * [coils:](../../config/coils.md)
+* [opp_coils:](../../config/opp_coils.md)
 
 There are a few things to know about controlling drivers and coils with
 OPP hardware.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1294,7 +1294,6 @@ nav:
     - MPF's default shows: shows/default_shows.md
     - Starting & stopping shows: shows/playing.md
     - Synchronizing multiple shows: shows/sync_ms.md
-    - Playing Shows in a Show: shows/shows_in_shows.md
   - MPF Errors from Log Files:
     - logs/index.md
     - CFE-coils-1: logs/CFE-coils-1.md

Original file line number	Diff line number	Diff line change
`@@ -45,4 +45,4 @@ light_player:`
`45`	`45`
`46`	`46`	`## Related How To guides`
`47`	`47`
`48`		`---8<-- "todo.md"`
	`48`	`+* [Lights](../mechs/lights/index.md)`