Contribute

We’re building the ultimate Minecraft documentation project and if you’re interested in making things even better this is the page for you.

This page will be split up into three sections to help you get about:

New Ideas
New Content
Improving Content

Submitting Ideas

If you’re an administrator looking for docs that we don’t currently have information on then this is probably the section for you, it will explain how to raise a new GitHub issue with the information required for us to get the ball rolling with your request.

Head on over to the Admincraft GitHub repository
In the menu bar at the top select ‘Issues’
Select ‘New Issue’
Select ‘Feature Request’
Complete the required sections on the provided form

Ensure you fill out the form with as much information as you can as this will help us build better documentation

Writing Content

If you’re interested in writing content / migrating your own doc environment over to our wiki a GitHub PR is your best option.

Single Articles

If you’re going to write a single article you can do so with the following steps, before you consider uploading a document please ensure it is based on the template below. Copy it into a new .mdx file inside src/content/docs/ and replace the placeholder content with your own.

---
title: Your Page Title
description: A short one line summary of the page, this is used for search engines and link previews.
lastUpdated: YYYY-MM-DD
---

A short introduction explaining what this page covers and who it's for. Keep it to a couple of sentences so the reader knows straight away whether they're in the right place.

### First Section

Explain the first part of your topic here. Use `###` for main sections and `####` for anything nested underneath them.

<ul class="pl-5 list-disc">
  <li>Use this list style for bullet points</li>
  <li>It keeps spacing consistent across the wiki</li>
  <li>Links look like [this](https://example.com)</li>
</ul>

:::note
Use a note for helpful information that isn't essential to the steps.
:::

---

### Second Section

Code, commands and config go in a fenced block with the language set so it's highlighted correctly.

```bash
java -Xms4G -Xmx4G -jar server.jar nogui
```

:::caution
Use a caution for anything that could break a server or lose data if it's done wrong.
:::

Tables are useful for comparing options or listing values.

Option | Description
------------ | -------
`example-one` | What this option does
`example-two` | What this option does

---

### Summary

Close out with a short summary or point the reader at the logical next page.

Images should be placed in src/assets/docs/ following the same folder structure as your page and referenced with a relative path, for example ![Alt Text](../../../assets/docs/your-section/your-page/image.png).

Once your article is ready:

Head on over to the Admincraft GitHub repository
In the menu bar at the top select ‘Pull Requests’
Select ‘New Pull Request’
Select the branch of your forked repo that you wish to commit as a PR
Select ‘View Pull Request’

The Admincraft contributors will then verify the PR is good and will approve your content.

Improving Content

As Minecraft continues to grow so will our project and we hope that if you spot inconsistencies in our project you’ll hit the ‘Edit Page’ link at the bottom to submit a PR request with any corrections you wish to make.