Documentation help
-
Hi,
I'm sure this is a daft question, but how do we contribute to the new docs area?
https://retropie.org.uk/docs/Or is the Wiki still being maintained/updated and elements copied across?
https://github.com/retropie/retropie-setup/wikiPlease read the Docs before asking a new question.
RetroPie Help Guides: https://goo.gl/3gcNsT -
@Floob I think the new Docs are just a copy of the existing wiki. I think they just update however often.
-
@Floob yes they are more or less the same, the pretty docs are just a mirror of the wiki
Jools integrated a module that builds the pretty docs from the wiki. I can run it manually and it will autogenerate the docs (an SSH key to the retropie server is required). We have considered automating it but have decided against it for now in case someone does something stupid on the wiki, there are also some bugs with the default markdown parser so I'm running a patched parser on my PC until those bugs are fixed upstream.
I get emails anytime the wiki is updated and I generate the docs at least weekly.
There is a config file that defines the pagination here: https://github.com/RetroPie/RetroPie-Docs it also includes some CSS/ custom configs for the layout
If you read the documentation it will answer 99% of your questions: https://retropie.org.uk/docs/
Also if you want a solution to your problems read this first: https://retropie.org.uk/forum/topic/3/read-this-first
-
Great stuff, thanks for the confirmation.
-
@herb_fargus Are there docs in retropie.org.uk/docs that aren't present in the wiki?
I've found a broken link in https://retropie.org.uk/docs/Controller-Configuration/ and searched in the wiki to fix it, but didn't find.
The broken link is in this paragraph:
You can also configure controls for individual systems and individual games. For more advanced controller configuration with libretro cores (any emulator that starts with
lr) see the RetroArch-Configuration page.The link points to
.../retroarch-configurationbut the correct is.../RetroArch-Configuration. Yes, the only difference is the capital letters R, A and C. By the way, I didn't even know that URLs were case sensitive! -
@meleu said in Documentation help:
@herb_fargus Are there docs in retropie.org.uk/docs that aren't present in the wiki?
Yes but some I intentionally left out
I've found a broken link in https://retropie.org.uk/docs/Controller-Configuration/ and searched in the wiki to fix it, but didn't find.
Must have missed it will fix when I find a moment
Contributions to the project are always appreciated, so if you would like to support us with a donation you can do so here.
Hosting provided by Mythic-Beasts. See the Hosting Information page for more information.