Merge pull request #316 from microsoft/pete-dev

Restructuring docs
microsoft · Apr 17, 2024 · 8ba5ab8 · 8ba5ab8
2 parents eeae111 + 1981a50
commit 8ba5ab8
Show file tree

Hide file tree

Showing 85 changed files with 16 additions and 159 deletions.
diff --git a/...oper-docs/Windows.Devices.Midi2/README.md → docs/api/README.md b/...oper-docs/Windows.Devices.Midi2/README.md → docs/api/README.md
diff --git a/.../Windows.Devices.Midi2/clock/MidiClock.md → docs/api/clock/MidiClock.md b/.../Windows.Devices.Midi2/clock/MidiClock.md → docs/api/clock/MidiClock.md
diff --git a/...ctions/IMidiEndpointConnectionSettings.md → ...ctions/IMidiEndpointConnectionSettings.md b/...ctions/IMidiEndpointConnectionSettings.md → ...ctions/IMidiEndpointConnectionSettings.md
diff --git a/...nections/IMidiEndpointConnectionSource.md → ...nections/IMidiEndpointConnectionSource.md b/...nections/IMidiEndpointConnectionSource.md → ...nections/IMidiEndpointConnectionSource.md
diff --git a/...ctions/IMidiMessageReceivedEventSource.md → ...ctions/IMidiMessageReceivedEventSource.md b/...ctions/IMidiMessageReceivedEventSource.md → ...ctions/IMidiMessageReceivedEventSource.md
diff --git a/...di2/connections/MidiEndpointConnection.md → ...api/connections/MidiEndpointConnection.md b/...di2/connections/MidiEndpointConnection.md → ...api/connections/MidiEndpointConnection.md
diff --git a/...nnections/MidiMessageReceivedEventArgs.md → ...nnections/MidiMessageReceivedEventArgs.md b/...nnections/MidiMessageReceivedEventArgs.md → ...nnections/MidiMessageReceivedEventArgs.md
diff --git a/.../connections/MidiSendMessageResultEnum.md → .../connections/MidiSendMessageResultEnum.md b/.../connections/MidiSendMessageResultEnum.md → .../connections/MidiSendMessageResultEnum.md
diff --git a/...ndows.Devices.Midi2/connections/README.md → docs/api/connections/README.md b/...ndows.Devices.Midi2/connections/README.md → docs/api/connections/README.md
diff --git a/...meration/MidiEndpointDeviceInformation.md → ...meration/MidiEndpointDeviceInformation.md b/...meration/MidiEndpointDeviceInformation.md → ...meration/MidiEndpointDeviceInformation.md
diff --git a/...idiEndpointDeviceInformationFilterEnum.md → ...idiEndpointDeviceInformationFilterEnum.md b/...idiEndpointDeviceInformationFilterEnum.md → ...idiEndpointDeviceInformationFilterEnum.md
diff --git a/...EndpointDeviceInformationSortOrderEnum.md → ...EndpointDeviceInformationSortOrderEnum.md b/...EndpointDeviceInformationSortOrderEnum.md → ...EndpointDeviceInformationSortOrderEnum.md
diff --git a/...dpointDeviceInformationUpdateEventArgs.md → ...dpointDeviceInformationUpdateEventArgs.md b/...dpointDeviceInformationUpdateEventArgs.md → ...dpointDeviceInformationUpdateEventArgs.md
diff --git a/...meration/MidiEndpointDevicePurposeEnum.md → ...meration/MidiEndpointDevicePurposeEnum.md b/...meration/MidiEndpointDevicePurposeEnum.md → ...meration/MidiEndpointDevicePurposeEnum.md
diff --git a/.../enumeration/MidiEndpointDeviceWatcher.md → .../enumeration/MidiEndpointDeviceWatcher.md b/.../enumeration/MidiEndpointDeviceWatcher.md → .../enumeration/MidiEndpointDeviceWatcher.md
diff --git a/...ndows.Devices.Midi2/enumeration/README.md → docs/api/enumeration/README.md b/...ndows.Devices.Midi2/enumeration/README.md → docs/api/enumeration/README.md
diff --git a/...2/message-utilities/MidiMessageBuilder.md → ...i/message-utilities/MidiMessageBuilder.md b/...2/message-utilities/MidiMessageBuilder.md → ...i/message-utilities/MidiMessageBuilder.md
diff --git a/...message-utilities/MidiMessageConverter.md → ...message-utilities/MidiMessageConverter.md b/...message-utilities/MidiMessageConverter.md → ...message-utilities/MidiMessageConverter.md
diff --git a/...2/message-utilities/MidiMessageUtility.md → ...i/message-utilities/MidiMessageUtility.md b/...2/message-utilities/MidiMessageUtility.md → ...i/message-utilities/MidiMessageUtility.md
diff --git a/...age-utilities/MidiStreamMessageBuilder.md → ...age-utilities/MidiStreamMessageBuilder.md b/...age-utilities/MidiStreamMessageBuilder.md → ...age-utilities/MidiStreamMessageBuilder.md
diff --git a/...Devices.Midi2/message-utilities/README.md → docs/api/message-utilities/README.md b/...Devices.Midi2/message-utilities/README.md → docs/api/message-utilities/README.md
diff --git a/...es.Midi2/messages/IMidiUniversalPacket.md → docs/api/messages/IMidiUniversalPacket.md b/...es.Midi2/messages/IMidiUniversalPacket.md → docs/api/messages/IMidiUniversalPacket.md
diff --git a/...ges/Midi1ChannelVoiceMessageStatusEnum.md → ...ges/Midi1ChannelVoiceMessageStatusEnum.md b/...ges/Midi1ChannelVoiceMessageStatusEnum.md → ...ges/Midi1ChannelVoiceMessageStatusEnum.md
diff --git a/...ges/Midi2ChannelVoiceMessageStatusEnum.md → ...ges/Midi2ChannelVoiceMessageStatusEnum.md b/...ges/Midi2ChannelVoiceMessageStatusEnum.md → ...ges/Midi2ChannelVoiceMessageStatusEnum.md
diff --git a/...s/MidiEndpointDiscoveryFilterFlagsEnum.md → ...s/MidiEndpointDiscoveryFilterFlagsEnum.md b/...s/MidiEndpointDiscoveryFilterFlagsEnum.md → ...s/MidiEndpointDiscoveryFilterFlagsEnum.md
diff --git a/...iFunctionBlockDiscoveryFilterFlagsEnum.md → ...iFunctionBlockDiscoveryFilterFlagsEnum.md b/...iFunctionBlockDiscoveryFilterFlagsEnum.md → ...iFunctionBlockDiscoveryFilterFlagsEnum.md
diff --git a/....Devices.Midi2/messages/MidiMessage128.md → docs/api/messages/MidiMessage128.md b/....Devices.Midi2/messages/MidiMessage128.md → docs/api/messages/MidiMessage128.md
diff --git a/...s.Devices.Midi2/messages/MidiMessage32.md → docs/api/messages/MidiMessage32.md b/...s.Devices.Midi2/messages/MidiMessage32.md → docs/api/messages/MidiMessage32.md
diff --git a/...s.Devices.Midi2/messages/MidiMessage64.md → docs/api/messages/MidiMessage64.md b/...s.Devices.Midi2/messages/MidiMessage64.md → docs/api/messages/MidiMessage64.md
diff --git a/...s.Devices.Midi2/messages/MidiMessage96.md → docs/api/messages/MidiMessage96.md b/...s.Devices.Midi2/messages/MidiMessage96.md → docs/api/messages/MidiMessage96.md
diff --git a/...vices.Midi2/messages/MidiMessageStruct.md → docs/api/messages/MidiMessageStruct.md b/...vices.Midi2/messages/MidiMessageStruct.md → docs/api/messages/MidiMessageStruct.md
diff --git a/...ces.Midi2/messages/MidiMessageTypeEnum.md → docs/api/messages/MidiMessageTypeEnum.md b/...ces.Midi2/messages/MidiMessageTypeEnum.md → docs/api/messages/MidiMessageTypeEnum.md
diff --git a/...ices.Midi2/messages/MidiPacketTypeEnum.md → docs/api/messages/MidiPacketTypeEnum.md b/...ices.Midi2/messages/MidiPacketTypeEnum.md → docs/api/messages/MidiPacketTypeEnum.md
diff --git a/...essages/MidiSystemExclusive8StatusEnum.md → ...essages/MidiSystemExclusive8StatusEnum.md b/...essages/MidiSystemExclusive8StatusEnum.md → ...essages/MidiSystemExclusive8StatusEnum.md
diff --git a/.../Windows.Devices.Midi2/messages/README.md → docs/api/messages/README.md b/.../Windows.Devices.Midi2/messages/README.md → docs/api/messages/README.md
diff --git a/...vices.Midi2/metadata/MidiFunctionBlock.md → docs/api/metadata/MidiFunctionBlock.md b/...vices.Midi2/metadata/MidiFunctionBlock.md → docs/api/metadata/MidiFunctionBlock.md
diff --git a/...etadata/MidiFunctionBlockDirectionEnum.md → ...etadata/MidiFunctionBlockDirectionEnum.md b/...etadata/MidiFunctionBlockDirectionEnum.md → ...etadata/MidiFunctionBlockDirectionEnum.md
diff --git a/...2/metadata/MidiFunctionBlockMidi10Enum.md → ...i/metadata/MidiFunctionBlockMidi10Enum.md b/...2/metadata/MidiFunctionBlockMidi10Enum.md → ...i/metadata/MidiFunctionBlockMidi10Enum.md
diff --git a/...2/metadata/MidiFunctionBlockUIHintEnum.md → ...i/metadata/MidiFunctionBlockUIHintEnum.md b/...2/metadata/MidiFunctionBlockUIHintEnum.md → ...i/metadata/MidiFunctionBlockUIHintEnum.md
diff --git a/....Midi2/metadata/MidiGroupTerminalBlock.md → docs/api/metadata/MidiGroupTerminalBlock.md b/....Midi2/metadata/MidiGroupTerminalBlock.md → docs/api/metadata/MidiGroupTerminalBlock.md
diff --git a/...ta/MidiGroupTerminalBlockDirectionEnum.md → ...ta/MidiGroupTerminalBlockDirectionEnum.md b/...ta/MidiGroupTerminalBlockDirectionEnum.md → ...ta/MidiGroupTerminalBlockDirectionEnum.md
diff --git a/...ata/MidiGroupTerminalBlockProtocolEnum.md → ...ata/MidiGroupTerminalBlockProtocolEnum.md b/...ata/MidiGroupTerminalBlockProtocolEnum.md → ...ata/MidiGroupTerminalBlockProtocolEnum.md
diff --git a/.../Windows.Devices.Midi2/metadata/README.md → docs/api/metadata/README.md b/.../Windows.Devices.Midi2/metadata/README.md → docs/api/metadata/README.md
diff --git a/...s/IMidiEndpointMessageProcessingPlugin.md → ...s/IMidiEndpointMessageProcessingPlugin.md b/...s/IMidiEndpointMessageProcessingPlugin.md → ...s/IMidiEndpointMessageProcessingPlugin.md
diff --git a/...ng-plugins/MidiChannelEndpointListener.md → ...ng-plugins/MidiChannelEndpointListener.md b/...ng-plugins/MidiChannelEndpointListener.md → ...ng-plugins/MidiChannelEndpointListener.md
diff --git a/...sing-plugins/MidiGroupEndpointListener.md → ...sing-plugins/MidiGroupEndpointListener.md b/...sing-plugins/MidiGroupEndpointListener.md → ...sing-plugins/MidiGroupEndpointListener.md
diff --git a/...lugins/MidiMessageTypeEndpointListener.md → ...lugins/MidiMessageTypeEndpointListener.md b/...lugins/MidiMessageTypeEndpointListener.md → ...lugins/MidiMessageTypeEndpointListener.md
diff --git a/...evices.Midi2/processing-plugins/README.md → docs/api/processing-plugins/README.md b/...evices.Midi2/processing-plugins/README.md → docs/api/processing-plugins/README.md
diff --git a/...dows.Devices.Midi2/service/MidiService.md → docs/api/service/MidiService.md b/...dows.Devices.Midi2/service/MidiService.md → docs/api/service/MidiService.md
diff --git a/...ServiceConfigurationResponseStatusEnum.md → ...ServiceConfigurationResponseStatusEnum.md b/...ServiceConfigurationResponseStatusEnum.md → ...ServiceConfigurationResponseStatusEnum.md
diff --git a/.../service/MidiServiceEndpointDefinition.md → .../service/MidiServiceEndpointDefinition.md b/.../service/MidiServiceEndpointDefinition.md → .../service/MidiServiceEndpointDefinition.md
diff --git a/...iServiceLoopbackEndpointCreationResult.md → ...iServiceLoopbackEndpointCreationResult.md b/...iServiceLoopbackEndpointCreationResult.md → ...iServiceLoopbackEndpointCreationResult.md
diff --git a/...viceMessageProcessingPluginInformation.md → ...viceMessageProcessingPluginInformation.md b/...viceMessageProcessingPluginInformation.md → ...viceMessageProcessingPluginInformation.md
diff --git a/....Midi2/service/MidiServicePingResponse.md → docs/api/service/MidiServicePingResponse.md b/....Midi2/service/MidiServicePingResponse.md → docs/api/service/MidiServicePingResponse.md
diff --git a/...service/MidiServicePingResponseSummary.md → ...service/MidiServicePingResponseSummary.md b/...service/MidiServicePingResponseSummary.md → ...service/MidiServicePingResponseSummary.md
diff --git a/.../MidiServiceTransportPluginInformation.md → .../MidiServiceTransportPluginInformation.md b/.../MidiServiceTransportPluginInformation.md → .../MidiServiceTransportPluginInformation.md
diff --git a/...rvice/MidiSessionConnectionInformation.md → ...rvice/MidiSessionConnectionInformation.md b/...rvice/MidiSessionConnectionInformation.md → ...rvice/MidiSessionConnectionInformation.md
diff --git a/...s.Midi2/service/MidiSessionInformation.md → docs/api/service/MidiSessionInformation.md b/...s.Midi2/service/MidiSessionInformation.md → docs/api/service/MidiSessionInformation.md
diff --git a/...s/Windows.Devices.Midi2/service/README.md → docs/api/service/README.md b/...s/Windows.Devices.Midi2/service/README.md → docs/api/service/README.md
diff --git a/...s.Midi2/service/console-enum-sessions.png → docs/api/service/console-enum-sessions.png b/...s.Midi2/service/console-enum-sessions.png → docs/api/service/console-enum-sessions.png
diff --git a/...ws.Devices.Midi2/service/console-ping.png → docs/api/service/console-ping.png b/...ws.Devices.Midi2/service/console-ping.png → docs/api/service/console-ping.png
diff --git a/...dows.Devices.Midi2/session/MidiSession.md → docs/api/session/MidiSession.md b/...dows.Devices.Midi2/session/MidiSession.md → docs/api/session/MidiSession.md
diff --git a/...ices.Midi2/session/MidiSessionSettings.md → docs/api/session/MidiSessionSettings.md b/...ices.Midi2/session/MidiSessionSettings.md → docs/api/session/MidiSessionSettings.md
diff --git a/...s/Windows.Devices.Midi2/session/README.md → docs/api/session/README.md b/...s/Windows.Devices.Midi2/session/README.md → docs/api/session/README.md
diff --git a/...Devices.Midi2/simple-types/MidiChannel.md → docs/api/simple-types/MidiChannel.md b/...Devices.Midi2/simple-types/MidiChannel.md → docs/api/simple-types/MidiChannel.md
diff --git a/...s.Devices.Midi2/simple-types/MidiGroup.md → docs/api/simple-types/MidiGroup.md b/...s.Devices.Midi2/simple-types/MidiGroup.md → docs/api/simple-types/MidiGroup.md
diff --git a/...evices.Midi2/simple-types/MidiUniqueId.md → docs/api/simple-types/MidiUniqueId.md b/...evices.Midi2/simple-types/MidiUniqueId.md → docs/api/simple-types/MidiUniqueId.md
diff --git a/...dows.Devices.Midi2/simple-types/README.md → docs/api/simple-types/README.md b/...dows.Devices.Midi2/simple-types/README.md → docs/api/simple-types/README.md
diff --git a/...mConfigurationRequestReceivedEventArgs.md → ...mConfigurationRequestReceivedEventArgs.md b/...mConfigurationRequestReceivedEventArgs.md → ...mConfigurationRequestReceivedEventArgs.md
diff --git a/...rtual-device/MidiVirtualEndpointDevice.md → ...rtual-device/MidiVirtualEndpointDevice.md b/...rtual-device/MidiVirtualEndpointDevice.md → ...rtual-device/MidiVirtualEndpointDevice.md
diff --git a/...ce/MidiVirtualEndpointDeviceDefinition.md → ...ce/MidiVirtualEndpointDeviceDefinition.md b/...ce/MidiVirtualEndpointDeviceDefinition.md → ...ce/MidiVirtualEndpointDeviceDefinition.md
diff --git a/...ws.Devices.Midi2/virtual-device/README.md → docs/api/virtual-device/README.md b/...ws.Devices.Midi2/virtual-device/README.md → docs/api/virtual-device/README.md
diff --git a/docs/console/midi-console.md b/docs/console/midi-console.md
@@ -1,7 +1,6 @@
 ---
 layout: page
 title: MIDI Console
-parent: Windows MIDI Services
 has_children: true
 ---
 

diff --git a/docs/contributors/CONTRIBUTING.md b/docs/contributors/CONTRIBUTING.md
diff --git a/docs/contributors/README-Developer-Onboarding.md b/docs/contributors/README-Developer-Onboarding.md
diff --git a/docs/contributors/README.md b/docs/contributors/README.md
diff --git a/docs/endpoints/README.md b/docs/endpoints/README.md
@@ -1,7 +1,6 @@
 ---
 layout: page
 title: Transport Types
-parent: Windows MIDI Services
 has_children: true
 ---
 

diff --git a/docs/midi-dump.md b/docs/midi-dump.md
@@ -1,7 +1,7 @@
 ---
 layout: page
 title: MIDI Dump Utility
-parent: Windows Midi Services
+parent: 
 ---
 
 # Windows Dump Utility

diff --git a/docs/developer-docs/api-back-compat.md → docs/other-developer-docs/api-back-compat.md b/docs/developer-docs/api-back-compat.md → docs/other-developer-docs/api-back-compat.md
@@ -1,7 +1,7 @@
 ---
 layout: page
 title: API Backwards Compatibility
-parent: Windows Midi Services
+parent: For Developers
 ---
 
 # API Backwards Compatibility

diff --git a/docs/developer-docs/best-practices.md → docs/other-developer-docs/best-practices.md b/docs/developer-docs/best-practices.md → docs/other-developer-docs/best-practices.md
@@ -1,7 +1,7 @@
 ---
 layout: page
 title: Best Practices
-parent: Windows Midi Services
+parent: For Developers
 has_children: false
 ---
 

diff --git a/docs/developer-docs/consuming-midi-api.md → ...ther-developer-docs/consuming-midi-api.md b/docs/developer-docs/consuming-midi-api.md → ...ther-developer-docs/consuming-midi-api.md
@@ -1,7 +1,7 @@
 ---
 layout: page
 title: Consuming the MIDI API
-parent: Windows Midi Services
+parent: For Developers
 has_children: false
 ---
 

diff --git a/docs/other-developer-docs/developer.md b/docs/other-developer-docs/developer.md
@@ -0,0 +1,9 @@
+---
+layout: page
+title: For Developers
+has_children: true
+---
+
+# Developer Documentation
+
+In addition to the API documentation, here's additional developer documentation.
diff --git a/...veloper-docs/faq-programming-languages.md → ...veloper-docs/faq-programming-languages.md b/...veloper-docs/faq-programming-languages.md → ...veloper-docs/faq-programming-languages.md
@@ -1,7 +1,7 @@
 ---
 layout: page
 title: Programming Languages FAQ
-parent: Windows Midi Services
+parent: For Developers
 has_children: false
 ---
 

diff --git a/docs/developer-docs/internal-interfaces.md → ...her-developer-docs/internal-interfaces.md b/docs/developer-docs/internal-interfaces.md → ...her-developer-docs/internal-interfaces.md
@@ -1,7 +1,7 @@
 ---
 layout: page
 title: Internal Interfaces
-parent: Windows Midi Services
+parent: For Developers
 has_children: false
 ---
 

diff --git a/...oper-docs/midi2-implementation-details.md → ...oper-docs/midi2-implementation-details.md b/...oper-docs/midi2-implementation-details.md → ...oper-docs/midi2-implementation-details.md
@@ -1,7 +1,7 @@
 ---
 layout: page
 title: MIDI 2.0 Implementation Details
-parent: Windows MIDI Services
+parent: For Developers
 has_children: false
 ---