AutoKeyDocumentationLocations.md

AutoKey Documentation Locations

Current locations for documentation:

The documentation is in several places, none of which are identical, and some of which aren't served.

• AutoKey 0.94.1 and earlier:
  • 🛑 Use pre-legacy documentation.
  • 🛑 Served by: No longer served.
  • 🛑 Can use some legacy documentation, but some naming conventions changed.
• AutoKey 0.95.0 through AutoKey 0.95.10:
  • Use legacy documentation: https://autokey.github.io/autokey/index.html
  • Currently served by the master branch: https://github.com/autokey/autokey/tree/master/doc/scripting
  • Can be served by the develop branch: https://github.com/autokey/autokey/tree/develop/doc/scripting
  • 🛑 The files in the master and develop branches are not identical, but the only difference is a fixed typo in a comment in the epydoc.js file in the develop branch.
• AutoKey 0.96.0-beta-1 and later:
  • Use new documentation: https://autokey.github.io/index.html
  • Served by: https://github.com/autokey/autokey.github.io
  • Changes to this documentation only go live by running a manual action to rebuild the documentation pages.

Former locations for documentation:

The documentation was in three places, none of which were identical, and some of which wasn't served.

• AutoKey 0.94.1 and earlier:
  • Use pre-legacy documentation: https://autokey.github.io/index.html
  • Served by: https://github.com/autokey/autokey.github.io
  • 🛑 Can use some legacy documentation, but some naming conventions changed.
• AutoKey 0.95.0 through 0.95.10:
  • Use legacy documentation in the develop and/or master branch that isn't identical.
  • 🛑 Not served.
  • 🛑 Can use some pre-legacy documentation, but some naming conventions changed.
• AutoKey 0.96.0-beta-1 and later:
  • Use new documentation: https://autokey.github.io/autokey/
  • 🛑 Served by Sphinx and Jekyll and GitHub Actions.