Skip to content

Ainex Wiki Contribution Guide

Prerequisites

Prerequisites

  • Knowledge and a copy of Git
  • A GitHub account

For testing

You'll need MkDocs installed locally via Python to test your changes.

  1. Python 3.7+

  2. Ensure Python gets added to your PATH

  3. MkDocs, and mkdocs-material:

  4. Run python -m pip install mkdocs mkdocs-material in your command prompt
Instructions

Instructions

If this is your first time contributing, be sure to read this entire section before you begin.

  1. Clone the repo and open it in your favorite editor.

  2. If your editor creates editor-specific files, add them to the .gitignore file.

  3. Write your article using Markdown. The many features of Markdown extensions can be found in the links below. If you'd like to use a Markdown extension not listed in mkdocs.yml, you may add them to the list. You should ensure compatibility with other articles (so their layout does not accidentally change) before your changes are merged.

  4. Test and spell-check your article before it is merged.

  5. Submit a pull request to the wiki repo

Testing

Testing

To serve your copy of the website for testing:

  1. Run python -m mkdocs serve in your command prompt

  2. Open 127.0.0.1:8000 in your browser (be sure not to include http(s):// this will cause errors in the browser)

  3. If you get any errors, read them carefully. The most common errors are broken links. You may have typed them wrong.

  4. Keep in mind that / resolves to the docs folder. So, this page for example would be located at /meta/contributing
  5. Embedded images must have extensions. Links to documents on this Wiki must have extensions. Articles on the wiki are do not need .md extensions (except in mkdocs.yml).

Guidelines

  1. Never attach files or links to content that is private to another party.
    This includes leaked documentation (such as the XDK), piracy websites and other pirated content.
  2. If you attach a link to code on GitHub in your article, make sure to get the permalink.
    Attaching links to branches (such as master/main) leads to dead or incorrect links down the road!

Tips

Stumped on how to do something? These resources might help!

  • MkDocs Material Setup Explains the setup of MkDocs Material sites, such as fonts, colors, and navigation.
  • MkDocs Material Reference
    Includes details about the features of MkDocs Material, the theme used by Ainex Wiki. Want to know how to use features like emoji, tables, buttons, and diagrams? It's all in there.

Tools

  • Ainex - You'll probably need it!
  • Lightshot - An easy screenshot program for Windows and Mac
    Has a few more features than Snipping Tool, including automatic upload and a dedicated screenshot hotkey.
    • In Windows 10 version 1803, build 17661 and higher, there is now a built-in shortcut feature that works like Lightshot.
      To use it, just press Win+Shift+S.
  • Spectacle - A good alternative to Lightshot, on Linux. Included in some KDE distributions. By default, the shortcut is simply Print Screen.

Suggestions

Config Options are often added updated, and could always use documentation.

Additional languages can be supported. Although Ainex itself does not yet support multiple languages, the wiki can! If you would like to translate the wiki to your language, start here!