cross link core api concept pages

bosh · bosh · commit 50af6318854c · 2025-07-15T23:08:00.000-07:00
diff --git a/docs/code/api_reference/core/auditor.md b/docs/code/api_reference/core/auditor.md
@@ -1,9 +1,5 @@
 # auditor API Reference
 
-Config Reference:
-
-* [auditor:](../../../config/auditor.md)
-
 `self.machine.auditor`
 
 ``` python
@@ -70,3 +66,8 @@ Parameters:
 `enabled`
 
 Attribute that's viewed by other core components to let them know they should send auditing events. Set this via the enable() and disable() methods.
+
+## Related Pages:
+
+* [auditor: Config Reference](../../../config/auditor.md)
+* [Machine Management: Auditor](../../../machine_management/auditor.md)
diff --git a/docs/code/api_reference/core/bcp.md b/docs/code/api_reference/core/bcp.md
@@ -1,9 +1,5 @@
 # bcp API Reference
 
-Config Reference:
-
-* [bcp:](../../../config/bcp.md)
-
 `self.machine.bcp`
 
 ``` python
@@ -29,3 +25,7 @@ Emulate legacy send.
 Parameters:
 
 * **bcp_command** – Commmand to send
+
+## Related Pages:
+
+* [bcp: Config Reference](../../../config/bcp.md)
diff --git a/docs/code/api_reference/core/events.md b/docs/code/api_reference/core/events.md
@@ -174,3 +174,7 @@ Wait for any event from event_names.
 `wait_for_event(event_name: str) → _asyncio.Future`
 
 Wait for event.
+
+## Related Pages:
+
+* [Events Overview](../../../events/overview/index.md)
diff --git a/docs/code/api_reference/core/info_lights.md b/docs/code/api_reference/core/info_lights.md
@@ -1,9 +1,5 @@
 # info_lights API Reference
 
-Config Reference:
-
-* [info_lights:](../../../config/info_lights.md)
-
 `self.machine.info_lights`
 
 ``` python
@@ -21,3 +17,7 @@ There is only one instance of the info_lights in MPF, and it's accessible via `s
 ## Methods & Attributes
 
 The `info_lights` has the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
+
+## Related Pages:
+
+* [info_lights: Config Reference](../../../config/info_lights.md)
diff --git a/docs/code/api_reference/core/machine.md b/docs/code/api_reference/core/machine.md
@@ -1,9 +1,5 @@
 # machine API Reference
 
-Config Reference:
-
-* [machine:](../../../config/machine.md)
-
 `self.machine`
 
 ``` python
@@ -114,3 +110,7 @@ Validate a config section.
 `verify_system_info()`
 
 Dump information about the Python installation to the log. Information includes Python version, Python executable, platform, and core architecture.
+
+## Related Pages:
+
+* [machine: Config Reference](../../../config/machine.md)
diff --git a/docs/code/api_reference/core/placeholder_manager.md b/docs/code/api_reference/core/placeholder_manager.md
@@ -21,3 +21,7 @@ The placeholder_manager has the following methods & attributes available. Note t
 `get_global_parameters(name)`
 
 Return global params.
+
+## Related Pages:
+
+* [Using dynamic runtime values in config files](../../../config/instructions/dynamic_values.md)
diff --git a/docs/code/api_reference/core/service.md b/docs/code/api_reference/core/service.md
@@ -45,3 +45,9 @@ Start service mode.
 `stop_service()`
 
 Stop service mode.
+
+## Related Pages:
+
+* [service Mode API Reference](../modes/service.md)
+* [Game Logic: Service Mode](../../../game_logic/service_mode.md)
+* [Machine Management: Service Mode](../../../machine_management/service_mode.md)
diff --git a/docs/code/api_reference/core/settings.md b/docs/code/api_reference/core/settings.md
@@ -1,9 +1,5 @@
 # settings API Reference
 
-Config Reference:
-
-* [settings:](../../../config/settings.md)
-
 `self.machine.settings`
 
 ``` python
@@ -45,3 +41,7 @@ Return all available settings.
 `set_setting_value(setting_name, value)`
 
 Set the value of a setting.
+
+## Config Reference:
+
+* [settings: Config Reference](../../../config/settings.md)
diff --git a/docs/code/api_reference/core/switch_controller.md b/docs/code/api_reference/core/switch_controller.md
@@ -174,3 +174,7 @@ Parameters:
 * **state** – The state to wait for. 0 = inactive, 1 = active, 2 = opposite to current.
 * **only_on_change** – Bool which controls whether this wait will be triggered now if the switch is already in the state, or whether it will wait until the switch changes into that state.
 * **ms** – How long the switch needs to be in the new state to trigger the wait.
+
+## Related Pages:
+
+* [How MPF handles switches: The Switch Controller](../../../mechs/switches/switch_controller.md)
diff --git a/docs/code/api_reference/core/switch_player.md b/docs/code/api_reference/core/switch_player.md
@@ -1,9 +1,5 @@
 # switch_player API Reference
 
-Config Reference:
-
-* [switch_player:](../../../config/switch_player.md)
-
 `self.machine.switch_player`
 
 ``` python
@@ -21,3 +17,7 @@ There is only one instance of the `switch_player` in MPF, and it's accessible vi
 ## Methods & Attributes
 
 The `switch_player` has the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
+
+## Related Pages:
+
+* [switch_player: Config Reference](../../../config/switch_player.md)
diff --git a/docs/code/api_reference/core/text_ui.md b/docs/code/api_reference/core/text_ui.md
@@ -1,9 +1,5 @@
 # text_ui API Reference
 
-Config Reference:
-
-* [text_ui:](../../../config/text_ui.md)
-
 `self.machine.text_ui`
 
 ``` python
@@ -25,3 +21,7 @@ The text_ui has the following methods & attributes available. Note that methods
 `stop(**kwargs)`
 
 Stop the Text UI and restore the original console screen.
+
+## Related Pages:
+
+* [text_ui: Config Reference](../../../config/text_ui.md)
diff --git a/docs/code/api_reference/core/twitch_bot.md b/docs/code/api_reference/core/twitch_bot.md
@@ -1,9 +1,5 @@
 # twitch_bot API Reference
 
-Config Reference:
-
-* [twitch_client:](../../../config/twitch_client.md)
-
 `self.machine.twitch_bot`
 
 ``` python
@@ -21,3 +17,7 @@ There is only one instance of the `twitch_bot` in MPF, and it's accessible via `
 ## Methods & Attributes
 
 The `twitch_bot` has the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
+
+## Related Pages:
+
+* [twitch_client: Config Reference](../../../config/twitch_client.md)
diff --git a/docs/code/api_reference/modes/service.md b/docs/code/api_reference/modes/service.md
@@ -132,3 +132,9 @@ Returns true if the mode is running. Otherwise false.
 Log a message at the warning level.
 
 These messages will always be shown in the console and the log file.
+
+## Related Pages:
+
+* [service API Reference](../core/service.md)
+* [Game Logic: Service Mode](../../../game_logic/service_mode.md)
+* [Machine Management: Service Mode](../../../machine_management/service_mode.md)
diff --git a/docs/config/auditor.md b/docs/config/auditor.md
@@ -93,6 +93,7 @@ Default: `ball_ended`
 Events in this list, when posted, trigger the auditor to save its audits
 to disk.
 
-## Related How To guides
+## Related Pages:
 
 * [Auditor](../machine_management/auditor.md)
+* [auditor API Reference](../code/api_reference/core/auditor.md)
diff --git a/docs/config/bcp.md b/docs/config/bcp.md
@@ -70,7 +70,8 @@ this is used for the
 MPF supports connecting to multiple servers simultaneously which is why
 you can add multiple entries here.
 
-## Related How To guides
+## Related Pages:
 
 * [The MPF Unity BCP Server](../mc/unity_bcp_server.md)
 * [Creating your own Media Controller](../mc/creating_your_own.md)
+* [bcp API Reference](../code/api_reference/core/bcp.md)
diff --git a/docs/config/info_lights.md b/docs/config/info_lights.md
@@ -139,3 +139,7 @@ Turns this light on when the machine tilts.
 
 Flashes this light when a game is not in progress at a rate of 1/2 sec
 on, 1/2 sec off.
+
+## Related Pages:
+
+* [info_lights API Reference](../code/api_reference/core/info_lights.md)
diff --git a/docs/config/machine.md b/docs/config/machine.md
@@ -44,6 +44,6 @@ you specify the minimum number of balls that need to be installed in
 order for a game to start. Note that it's up to you to make sure your
 game code can handle fewer balls than you might be expecting.
 
-## Related How To guides
+## Related Pages:
 
-* [How to configure an older style trough with two coils and only](../mechs/troughs/two_coil_one_switch.md)
+* [machine API Reference](../code/api_reference/core/machine.md)
diff --git a/docs/config/settings.md b/docs/config/settings.md
@@ -85,9 +85,9 @@ name of this setting as machine variable.
 
 Single value, type: `string`. Default: `standard`
 
---8<-- "todo.md"
 
-## Related How To guides
+## Related Pages:
 
 * [Machine Management - Service Mode](../machine_management/service_mode.md)
 * [Game Logic - Service Mode](../game_logic/service_mode.md)
+* [settings API Reference](../code/api_reference/core/settings.md)
diff --git a/docs/config/switch_player.md b/docs/config/switch_player.md
@@ -77,6 +77,7 @@ Unknown type. See description below.
 
 The steps of the switch_player. See the example above.
 
-## Related How To guides
+## Related Pages:
 
 * [plugins:](plugins.md)
+* [switch_player API Reference](../code/api_reference/core/switch_player.md)
diff --git a/docs/config/text_ui.md b/docs/config/text_ui.md
@@ -55,6 +55,7 @@ Text UI.
 If the `player_vars:` setting is not included in your config, *all*
 player variables will be displayed.
 
-## Related How To guides
+## Related Pages:
 
 * [Dynamically Updating Text](../mc/widgets/text/text_dynamic.md)
+* [text_ui API Reference](../code/api_reference/core/text_ui.md)
diff --git a/docs/config/twitch_client.md b/docs/config/twitch_client.md
@@ -98,6 +98,6 @@ This is the machine variable name that contains the user that will
 connect to Twitch. You may want to create a separate bot account on
 Twitch to use for this purpose.
 
-## Related How To guides
+## Related Pages:
 
---8<-- "todo.md"
+* [twitch_bot API Reference](../code/api_reference/core/twitch_bot.md)
diff --git a/docs/game_logic/service_mode.md b/docs/game_logic/service_mode.md
@@ -4,11 +4,6 @@ title: Service Mode
 
 # Service Mode
 
-
-Related Config File Sections:
-
-* [settings:](../config/settings.md)
-
 MPF has a build in service mode which can be extended using settings (or
 in code). Usually you map your
 [service switches and door switches](../mechs/switches/service_and_door_switches.md) to control service mode. Additionally, you might want to add
@@ -88,6 +83,11 @@ widget_styles:
     adjust_bottom: 3
 ```
 
-## Related How To guides:
+## Related Pages:
 
 * [How to design a game in MPF using Modes](../game_design/index.md)
+* [settings: Config Reference](../config/settings.md)
+
+* [service API Reference](../code/api_reference/core/service.md)
+* [service_mode API Reference](../code/api_reference/modes/service.md)
+* [Machine Management: Service Mode](../machine_management/service_mode.md)
diff --git a/docs/machine_management/auditor.md b/docs/machine_management/auditor.md
@@ -124,3 +124,8 @@ Note that in the 'Player' section, the auditor will track the average,
 the Top 10, and the total numbers of each item. You can configure all
 this (including how many of each item it records) in the `auditor:`
 section of the configuration file\`.
+
+## Related Pages:
+
+* [auditor: Config Reference](../config/auditor.md)
+* [auditor API Reference](../code/api_reference/core/auditor.md)
diff --git a/docs/machine_management/service_mode.md b/docs/machine_management/service_mode.md
@@ -72,3 +72,9 @@ MPF provides a **Diagnostics** function that allows the user to test
 hardware elements of the game such as switches, lights and coils. This
 menu option is available from the `service_menu_selected` event with the
 label `Diagnostics Menu`.
+
+## Related Pages:
+
+* [service API Reference](../code/api_reference/core/service.md)
+* [service_mode API Reference](../code/api_reference/modes/service.md)
+* [Game Logic: Service Mode](../game_logic/service_mode.md)
diff --git a/docs/mechs/switches/switch_controller.md b/docs/mechs/switches/switch_controller.md
@@ -53,3 +53,7 @@ reasons:
     All this is done by interfacing to the switch controller----your
     actual game code doesn't know (or care) where the original switch
     events came from.
+
+## Related Pages:
+
+* [switch_controller API Reference](../../code/api_reference/core/switch_controller.md)
