Skip to content

Contributing to the Wiki

hugomarins edited this page Apr 7, 2026 · 1 revision

Contributing to this Wiki

We welcome and encourage community contributions to this documentation! If you find something missing, unclear, or out of date, please help us improve it.

Note: Direct public editing is disabled for this wiki to prevent spam, so please follow the workflow below.

How to Contribute

1. Suggesting Changes (The Easiest Way)

If you don't feel comfortable writing the markdown yourself or simply want to report a missing topic, please open an Issue in the main project repository. You can simply explain what is missing, unclear, or out of date, and we will take care of it!

2. Submitting an Update via Issues

Because GitHub does not natively support the standard "Fork and Pull Request" workflow for wikis strictly via the web interface (and public editing is disabled), the most reliable way to propose major changes or rewritten pages is to:

  1. Copy the Markdown content of the page you want to edit from the wiki.
  2. Make your edits in a local text editor or any markdown tool.
  3. Open a new Issue in the main project repository titled "Wiki Update: [Page Name]".
  4. Paste your updated Markdown content directly in the issue body, or upload it, and briefly explain what you changed.

3. Advanced Git Workflow

If you are familiar with git, you can also clone this wiki's repository locally, make your changes, and provide a patch in an Issue or link to your own public repository. However, the copy-paste method via Issues described in step 2 is usually much faster!

(Note: While it's common in open-source to suggest "forking the wiki and posting a PR," GitHub Wiki repositories do not officially support web UI Forks/PRs. Standard GitHub Issues with your suggested markdown are the most effective method here!)

General Guidelines

When writing or editing wiki pages, please follow these general best practices:

  • Keep it Clear and Concise: Write simple sentences. Aim for clarity and avoid jargon where possible.
  • Use Formatting: Use bolding for UI elements (e.g., click the Dismiss button), and use standard Markdown headers (##) to organize content.
  • Link between pages: Use GitHub's standard wiki link format ([[Page Name]] or [[Link Text|Page-Name]]) to connect related concepts.
  • Screenshots: Explaining complex visual tasks is usually easier with screenshots or a short GIF. If adding images, simply attach them to your GitHub Issue and we will upload them to the wiki.

Thank you for helping us make the Incremental Everything documentation better for everyone!

Clone this wiki locally