Skip to content

Go through Wiki documentation #46

@C0rn3j

Description

@C0rn3j

We currently point to the dead upstream Wiki documentation at https://github.com/kozec/sc-controller, it had last 3 contributions from 2019-2022.
Keeping it as is problematic, since our version of sc-controller has not matched the Python 2.7 version for quite some time.

I like to avoid fragmentation, but it is not possible in this case, I have cloned the upstream wiki and put it at https://github.com/C0rn3j/sc-controller/wiki for now.
We need to:

  • Move existing docs to the wiki:

    • actions.md - linked to in the wiki
    • menu-file.md - linked to to in the wiki
    • protocol.md
    • protocol-file.md
  • Generic tasks:

    • Go through existing code and replace all kozec wiki mentions with C0rn3j wiki
    • Investigate update-wiki.py - Is this still needed?
    • Go through the wiki and check that mentions check out, and replace all info that does not match our fork
    • Scrape and reupload all pictures that point to external sources, make them point to /docs in the main repo (oxipng/jpegoptim etc the images as needed, see https://rys.rs/optimization)
    • Check if remote RetroPad is still insecure - https://github.com/C0rn3j/sc-controller/wiki/Using-phone-with-Retroarch-as-additional-controller
    • Perhaps nicely link every section on the Home page
    • Perhaps move some things from README.md to the wiki and link them instead, it is currently a bit noisy
  • Make sure that grammar is correct on all these pages and code blocks are colorized:

    • Custom-Action-Examples-and-Explanations.md
    • Evdev-and-HID-mode-for-non-Steam-controllers.md
    • Home.md
    • Running-SC-Controller-and-Steam.md
    • Running-SC-Controller-on-Windows.md
    • Status-icon-on-GNOME.md
    • Using-phone-with-Retroarch-as-additional-controller.md
    • actions.md
    • menu-file.md
    • protocol.md
    • protocol-file.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions