Skip to content

Commit

Permalink
mkdocs: more fixes and refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardoquesadawork committed Feb 21, 2024
1 parent a0d429b commit c53ea70
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 22 deletions.
16 changes: 8 additions & 8 deletions docs/getting_help.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Something not working as expected?

* :simple-discord: Post questions on [Discord server][discord_server]
* :simple-github: File bugs / feature requests in [Github Issue Tracker][github_issue_tracker]
* Post questions on [Discord server][discord_server] :simple-discord:
* File bugs / feature requests in [Github Issue Tracker][github_issue_tracker] :simple-github:

Add the following info:

Expand All @@ -14,8 +14,6 @@ Add the following info:
* Host Operating System you are using
* Debug log

[discord_server]: https://discord.gg/r5aMn6Cw5q

[github_issue_tracker]: https://github.com/ricardoquesada/bluepad32/issues

## Platforms
Expand Down Expand Up @@ -49,9 +47,9 @@ Not all controllers behave the same way... some are reliable... some not.

The officially supported controllers are enumerated here:

* [Supported gamepads][supported_gamepads]
* [Supported mice][supported_mice]
* [Supported keyboards][supported_keyboards]
* [Supported gamepads][supported_gamepads] :material-gamepad-variant:
* [Supported mice][supported_mice] :material-mouse:
* [Supported keyboards][supported_keyboards] :material-keyboard:

Please provide: brand, model, firmware and link to the device (if applicable).
Also mention whether it is genuine or a knock-off.
Expand All @@ -63,7 +61,7 @@ If you are using a controller not listed there, YOU ARE ON YOUR OWN!
### Supporting unsupported controllers

If you really want us to support a controller that is not supported, contact us (Send us a Private Message in
Discord channel :simple-discord:, or [file a feature request][github_bug] :simple-github: ). The way it works is:
[Discord][discord_server] :simple-discord:, or [file a feature request][github_bug] :simple-github: ). The way it works is:

* You send us a link to the controller that is not supported, like the Amazon or AliExpress link.
* You send us [via PayPal][paypal] :simple-paypal: the cost of the gamepad + shipping to the US.
Expand Down Expand Up @@ -106,3 +104,5 @@ E.g.: The console output can be found on this link (add link).

*(link to this page: <http://bit.ly/bluepad32-help>)*

[discord_server]: https://discord.gg/r5aMn6Cw5q

19 changes: 6 additions & 13 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,17 @@ In other words, it allows gamepads, keyboards and mice to connect to your projec

Non-exhaustive list:

* Sony DualSense, DualShock 4, DualShock 3
* Nintendo Switch, Wii U, Wii and Wii extensions
* Xbox Wireless
* Android
* 8BitDo
* Sony DualSense, DualShock 4, DualShock 3 :material-sony-playstation:
* Nintendo Switch, Wii U, Wii and Wii extensions :material-nintendo-switch:
* Xbox Wireless :material-microsoft-xbox-controller:
* Android :material-android:
* Keyboard
* Mouse
* and more

For detailed list see: [Supported gamepads][supported_gamepads], [supported mice][supported_mice]
and [supported keyboards][supported_keyboards].

If your favorite controller is not supported, [let us know][filing_a_bug].
For detailed list see: [Supported gamepads][supported_gamepads] :material-gamepad-variant:,
[supported mice][supported_mice] :material-mouse: and [supported keyboards][supported_keyboards] :material-keyboard:.

[supported_gamepads]: supported_gamepads

[supported_mice]: supported_mice

[supported_keyboards]: supported_keyboards

[filing_a_bug]: https://github.com/ricardoquesada/bluepad32/issues
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ nav:
- 'Architecture': architecture.md
- developer_notes.md
- 'Release Notes': release_notes.md
- 'Contributing': contributing.md
- 'Issue Tracker': https://github.com/ricardoquesada/bluepad32/issues
- About:
- Authors: authors.md
- license.md
- 'Contributing': contributing.md

theme:
name: material
Expand Down

0 comments on commit c53ea70

Please sign in to comment.