# Contributing to the Wiki

We're always looking for contributors to help get the wiki updated and in tip top shape. As of 7/10/25, if you've found something missing, outdated or incorrect, you can help us improve the Wiki by editing it directly on GitHub! This page explains how to get started and make your first contribution.

{% hint style="success" %}
**This guide assumes you have little to no experience with GitHub**

For experienced folk, you can skip the explanation and simply [fork the repo](https://github.com/vibecentralmc/wiki) and edit it with your preferred editor.\
\
**Please review the** [**editing guidelines**](#important-info-to-know-when-making-edits) **before making any edits!**
{% endhint %}

## Step 1 - Access the wiki repository on GitHub

First, head over to the GitHub website and [create an account or login](https://github.com/) if you haven't yet. A GitHub account is required to propose edits.

Once you're logged in, you can head over to the Wiki repository at <https://github.com/vibecentralmc/wiki>. This official repository page shows all the Wiki's most up-to-date page files and assets that are displayed nicely here on the GitBook frontend.

{% hint style="info" %}
For your privacy, we recommend going to <https://github.com/settings/emails> and enabling "**Keep my email addresses private**". This option uses a GitHub relay email to sign commits in place of your account email.
{% endhint %}

<figure><img src="/files/oZs1sKAK8VLJZRy79kdW" alt=""><figcaption></figcaption></figure>

## Step 2 - Create a fork of the repository

A "fork" on GitHub is a personal copy of a repository. Your fork is a working copy of the wiki where you'll make all your proposed edits.

To create your fork, simply click the "Fork" button on the top right of the repository (see image above).

Your created fork of the wiki will live at *<https://github.com/**`yourname`**/wiki>*

Even for multiple contributions over time, you'll always use the same fork. GitHub provides options (as outlined below) to sync your fork with the latest updates from the main repository as needed.

If you enjoy extra organization, you can leave your base fork free of edits and create a new branch to work in instead. Branches are essentially forks of your fork, and allow you to have separate working copies of the wiki for each of your pull requests. You can create and swap branches by using the dropdown in the top left, by default titled "main".

But, if you don't mind always building off the same working copy, or prefer a simpler experience, it's totally fine to not worry about branches and leave everything as is!

<figure><img src="/files/JLLZ9cnY219dvjTF0Gvc" alt=""><figcaption></figcaption></figure>

You can ensure you're on your fork by looking at the top - note how it says "forked from vibecentralmc/wiki".

### Understanding up to date status

Note the section near the top that shows "This branch is up to date with vibecentralmc/wiki:main". This means that both the official wiki repository and your fork are currently identical. As you or others make changes, this status will update. For example:

* "This branch is 3 commits ahead of vibecentralmc" means you have made and saved three changesets/commits to your fork that are not yet in the official wiki.
* "This branch is 1 commit behind vibecentralmc" means the official wiki has one changeset/commit that your fork doesn't yet have, and you'll need to sync your fork to get it using the "Sync fork" button.

### **Understanding commits**

In version control systems like Git, which are often used for codebases and other collaborative projects like wikis, a 'commit' or 'changeset' is essentially a group of one or more edits you made to the project at a specific point in time. You can think of it like saving a document and taking a snapshot of just those changes.

* **On GitHub, when you 'commit' changes,** you're packaging up a set of all your most recent changes since your last commit (like adding a new sentence, fixing a typo, etc.) and giving it a brief name & description of your primary changes, like "Fix typo in rules page" or "Create Skills page".
* **In GitHub, each commit builds on the previous one,** creating a chronological history of all edits to the project. This ensures everything is tracked and can be reverted or referenced if needed. You can explore all the commit history by clicking on "commits" in the top right of the project, and even browse the entire repository as a snapshot when a specific commit was made.

## Step 3 - Make your contributions in your fork

The Wiki pages use markdown formatting, similar to Discord. For example, you can bold text by surrounding it with two asterisk like `**this**` .

A large majority of the markdown that will be helpful to know can be learned at:

* <https://gitbook.com/docs/creating-content/formatting/markdown>&#x20;
* <https://www.markdownguide.org/basic-syntax/>

But for most purposes, you should be able to get the gist of it by just looking at existing pages on GitHub for reference and comparing their raw markdown and their rendered previews.

### **Important info to know when making edits**

{% hint style="success" %}

* Don't worry or bog yourself down about the complex formattings. Just focus on the content and accuracy of your contributions. **Any complex formattings can be added and fixed by staff later on - the raw content itself is what matters the most!**
* **Avoid adding your own images directly**, and opt for writing placeholders. ex. "\*image of menu here\*". This is so all screenshots across the entire wiki can be visually consistent and from the same game profile.
* GitBook uses special formatting and tokens to represent things like hint boxes (the box this text is in), that GitHub does not support rendering in previews. You can ignore these special tokens in the GitHub editor.
  {% endhint %}

**Now all that's left to do is find what you want to edit or add!**

### Editing an existing wiki page

You can find Table of Contents and quickly navigate to any existing wiki page by opening the `SUMMARY.md` file which is at the bottom of the repository page in the files section (highlighted in red):

<figure><img src="/files/9rmXgTmEjAJoszPGYsXi" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/e7a4WxSoovxZYKx3i5eu" alt=""><figcaption></figcaption></figure>

Once you open the page you'd like to edit, you'll see its preview opened. Click the edit button in the top right to make it editable (highlighted in red).

<figure><img src="/files/uQKK8K2fsQiOwBaOtLU3" alt=""><figcaption></figcaption></figure>

Now you can freely edit the page's markdown! Swap between "edit" and "preview" at the top left to see the rendered view of the page.

<figure><img src="/files/belfsAkc92ydavJlDhYl" alt=""><figcaption></figcaption></figure>

After you've made edits, click the green "commit changes" button in the top right and explain your changes. This will commit your edits to **your fork only** of the repository.

You can continue editing files like this and creating commits in your repository until you're ready to submit the changes to be merged into the live wiki.

### Creating a brand new wiki page or section

To create a new wiki page or section, navigate to the section where you'd like it to be, (ex. in the "survival" folder/section) and use the "Add file" button at the top right. Remember to name pages with the ".md" file extension!

{% hint style="success" %}
Copy and paste the new wiki page template below to get a solid base to work from for adding new pages.

All pages should follow this basic starting format, including the page title, description, and section headings with subheadings with respective empty lines.
{% endhint %}

```markup
# Page Title

A short description explaining what the feature is that this page is about

## Section Heading

Section content

### Section subheading

Subheading content

## Another Section Heading

More paragraph content, oh look a list!
* Bullet point item 1
* Bullet point item 2
```

{% hint style="warning" %}
If you create a new page, it has to be added to the `SUMMARY.md` file!
{% endhint %}

## Step 4 - Submit your contributions to be merged into the live Wiki

When you're ready to submit your changes to the official wiki live at [https://wiki.vibecentral.xyz](https://wiki.vibecentral.xyz/), head back to your fork's main page at *<https://github.com/**`yourname`**/wiki>* and click the "Contribute" button, then "Open Pull Request"&#x20;

<figure><img src="/files/5BbSkFuQhOCMLLa41WMc" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/c63LAqje6X7OGqi0DQ8y" alt=""><figcaption></figcaption></figure>

On the pull request page, just add a title and write a description of your changes, then click "Create pull request". None of the options at the top need to be adjusted :)&#x20;

When you create a pull request/PR, you're submitting your changes from your personal working copy / fork of the wiki to be merged or "pulled" into the official, main version.

PRs also serve as dedicated conversation threads. Staff members can reply in your PR to ask questions about your changes or request further edits if needed. If everything looks good, has no merge conflicts, and meets the wiki's standards, staff will approve your PR! Once approved, all your changes will be merged into the live wiki within minutes.

And that's it! Thank you for taking interest in contributing to the wiki, seriously, you're awesome!!

{% hint style="success" %}
Keep an eye out on #wiki-updates in Discord for updates to your PR, or use the "Watch" button in GitHub to receive email notifications. If it's your first PR, you can also request your Wiki Contributor badge in Discord once your PR is accepted!
{% endhint %}

## Using a text editor on your PC instead of GitHub's website

If you prefer to use a text editor on your pc, such as Notepad++ or another preferred editor to edit the wiki files, you can easily do so by cloning your fork locally using the [GitHub Desktop](https://github.com/apps/desktop) app or of course git commands if you're an experienced user.

Using GitHub Desktop, click Add Repository, and then Clone Repository. Select the type to be URL, and then supply your fork's repository URL or "yourname/wiki"

This will locally download the repository to your pc. Then, you can navigate to the files locally (by default, GitHub Desktop stores repositories in `Documents/GitHub`

As you make edits, you'll see your changes appear automatically in GitHub Desktop ready to be committed. When you're done editing, push those commits to your GitHub fork via the app and continue with the Pull Request process normally.

To sync changes from the official repository to your local copied repository, you can use the "Pull origin" button

<figure><img src="/files/S4Mu8R06yATrRuhyokbs" alt=""><figcaption></figcaption></figure>

## Have any questions or need any help with anything?

Just reach out! Using tickets on our [Discord](/general/discord.md) are the best way to get into contact with server staff. Your contributions are greatly valued <3


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wiki.vibecentral.xyz/general/contributing-to-the-wiki.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
