🤝 How to Contribute

This wiki only stays useful because alliance members keep it up to date. Your updates, new guides, and screenshots help everyone.

How the site is made

The wiki is written in simple Markdown files (the same format as these pages).

A tool called MkDocs (with the Material theme) turns these Markdown files into the nice website you see.

All the source files live in this Git repository.

When changes are accepted on the main branch, an automatic system (Forgejo Actions) builds the site and publishes it to ffz.codeberg.page within a minute or two. You never have to upload HTML files manually.

What is Git?

Git is a system that records the complete history of every change made to the files in the project. Think of it as "version history" for the entire wiki (who changed what, when, and why).

You don't need to understand Git deeply to contribute.

For bigger work (especially adding or modifying photos, creating new pages, or bigger restructurings), cloning the repository and working locally gives you full control and a much better experience.

The rest of this guide explains the "full Git" path. For simple text edits, you can use the web editor directly on Codeberg (no need to clone anything).

How to get material (photos, logos, etc.) from the repository

All images are stored in the docs/assets/images/ folder:

Hero portraits → docs/assets/images/hero/
Logos and other graphics → docs/assets/images/logo/
Diagrams (like faction counters) → docs/assets/images/

To view or download existing images:

Go to the repository on Codeberg
Navigate to docs → assets → images
Click the image you want
Click the Raw button — this gives you the direct image. Right-click → "Save image as..."

You can also clone the whole repository to your computer (see the "Working with the full repository" section) if you want all files locally.

Using the web interface

If you have (or create) a free Codeberg account, you can contribute changes — including adding new photos or screenshots — directly through the Codeberg website without needing to clone the repository or use Git commands on your computer. This is often the easiest path for occasional contributors.

Log in to your Codeberg account at https://codeberg.org.
Go to the repository: https://codeberg.org/FFz/pages
Navigate to the Markdown file you want to edit (or the folder where you want to create a new file).
Click the Edit button (or "Edit file") for that file. This opens Codeberg's online editor with a live preview.
Make your text changes in the editor.
To add a new photo or screenshot:
In the commit area at the bottom of the editor (or when creating the PR), look for the option to upload files or attach new files.
Upload your image (it will be placed in the correct location relative to the change).
Write a clear commit message describing your change.
Click Commit changes.
If you have write access (e.g. you are part of the development team), the change is committed directly.
If not, Codeberg will automatically create a Pull Request from a fork on your account for review.

This web flow supports uploading images directly and is sufficient for most contributions (text updates + new visuals).

Joining the development team (for regular contributors)

If you plan to contribute frequently (adding many guides, images, or helping maintain the wiki), it is much more convenient to become a member of the development team:

Create a free account on https://codeberg.org (if you don't have one).
Contact an R5 (or R4) in the alliance — via in-game mail, alliance chat, or Discord — and ask to be added to the FFz development team on Codeberg.
Once approved and added to the organization:

Permissions you will get: - Direct write access to the repository (changes can be committed without going through Pull Requests). - You can edit files via the web interface and have them applied directly (or push from local clone without forks). - Faster workflow for frequent work. - If given maintainer rights, you will also be able to review and merge other people's Pull Requests.

This level of access is reserved for trusted and active alliance members who regularly help with the wiki. It is not required for occasional contributions — you can always use the web interface or Pull Request route described above.

Working with the full repository (Git way)

For more complex changes or when you prefer to work locally with your own tools and preview:

Create a free account on https://codeberg.org (if you don't have one) and ask an R5 to add you to the development team (see the "Joining the development team" section for details on permissions).

Clone the repo:

git clone https://codeberg.org/FFz/pages.git
cd pages

Create a new branch for your changes:
```
git checkout -b my-new-guide
```
Edit Markdown files. If adding new images, place the files in the appropriate subfolder under docs/assets/images/ (see the "How to get material" section above for the folder structure, e.g. hero/ for portraits). Reference them in Markdown using relative paths (look at existing files such as the Heroes Gallery for examples of the correct relative syntax).
Preview locally (highly recommended):
```
pip install -r requirements.txt
mkdocs serve
```
Then open http://127.0.0.1:8000 in your browser. Changes appear live.

When you're happy, commit and push:

git add .
git commit -m "Add new guide about X and hero photo"
git push origin my-new-guide

On Codeberg, open a Pull Request from your branch to main.

A maintainer will review it, possibly suggest small changes, and merge it. The site will update automatically.

Guidelines

English (en/) is the main language. Update it first, then we can translate to the other languages.
Keep the friendly and practical tone of the existing pages.
Add "Last updated" at the bottom of new guides when relevant.
For big structural changes, discuss first with an R4 or R5.
Respect the existing emoji and formatting style.

Still not sure?

Just send the text, photo, or idea via in-game mail or alliance chat to an officer. We'll handle the technical part if needed.

Thank you — every small improvement helps the whole alliance play better together.

United by the Blade. ⚔️