Contribute to the documentation

The docs are written in Markdown if you need help with the syntax use this guide.

Mkdocs uses some Markdown extensions that you may have to familiarize with.

The documentation source is maintained via Git

For novice users that don't know how to use the command line you can use Github Desktop.

For more info on how to use git refer to their help

In order to propose improvements to a document:

  1. Clone the repo (If you are using Github Desktop, select Clone>Open in Desktop)
  2. Make the changes and update your clone
  3. Test, follow the Building section to render the site
  4. Propose your changes using the button "New Pull Request" in the docs repo

    make sure that you are comparing your forks edited branch to the docs master branch

There is a To-Do list for libretro/docs here

You can submit suggestions or issues regarding documentation at the libretro/docs issue tracker or in our forum thread.

Adding a new core

These are the documents that should be added/updated when a new core is added to the libretro ecosystem.

  • Add the core to docs/library/ (Follow the latest core template. docs/meta/
  • Add the core to mkdocs.yml
  • Add the core to docs/meta/
  • Add the core to docs/meta/ if it's related to another core in some way
  • Add the core to docs/tech/
  • Add the core to docs/meta/
  • Add the core to docs/guides/ if it supports softpatching
  • Add the core to docs/guides/ if it supports cheevos