Contribution Guidelines - dekay/vpinball-wiki GitHub Wiki

We welcome your help to improve this wiki. Whether you are fixing typos, expanding documentation, or writing a new guide, every contribution helps.

Conventions

  • Use VPX instead of "vpinball", "Visual Pinball", or other variations.
  • Avoid using hyphens in file names. GitHub can convert them into special characters. Instead, use capitalized words separated by spaces, e.g., Fix Broken Tables.

Formatting Guidelines

Use standard GitHub Markdown syntax for all edits.

Keep formatting clean and minimal. Follow these style practices:

  • Avoid horizontal lines (---, ***)
  • Use bold and italic text sparingly
  • Write in a clear, neutral tone. Informative and helpful is the goal

Changes

If you want to follow changes to this wiki via RSS, use this URL in your feed reader:
https://github.com/dekay/vpinball-wiki/wiki.atom
(For example, Feedbro for Firefox.)

Editing an Existing Page

  1. Navigate to the page you want to edit.
  2. Click the Edit button at the top right.
  3. Make your changes in the built-in GitHub editor.
  4. Use the Preview tab to check formatting before saving.
  5. Add a short description in the edit message field, such as Fixed typos or Added folder layout, then click Save page.

Creating a New Page

If your content does not fit within an existing page:

  1. Click the New Page button in the top right of the wiki.
  2. Give the page a short, descriptive title such as Table Setup Guide. Capitalize each word.
  3. GitHub will replace any spaces with hyphens in the page name, so Table Setup Guide becomes Table-Setup-Guide.
  4. Write your content using Markdown, checking it in the Preview tab.
  5. Add a brief edit message like Initial draft or Added cabinet notes, then click Save page.

[!IMPORTANT] Don't save this page you're looking at right now under a new name and edit its contents or you'll wipe it out.

Adding a New Page to the Sidebar

This wiki uses a custom sidebar instead of GitHub’s automatic alphabetical list.

To add your page:

  1. Click the pencil icon next to Visual Pinball Wiki in the sidebar.
  2. Insert a link to your new page using this format:
    [Page Title](Page_Title)
    For example, [Table Setup Guide](Table_Setup_Guide)
  3. Use the Preview tab to check formatting.
  4. Add an edit message and click Save page.