Skip to content

contributing.md

Latest commit

 

History

History
70 lines (56 loc) · 2.33 KB

contributing.md

File metadata and controls

70 lines (56 loc) · 2.33 KB
Raw
title Contributing
description How to contribute to this documentation
published true
date 2026-08-27 00:00:00 UTC
tags meta
editor markdown
dateCreated 2026-08-09 00:00:00 UTC

This wiki uses a Git repository. The wiki syncs in both directions with VolmitSoftware/docs.

Editing

Through Wiki.js. Use the pencil icon on any page. The next sync commits your change.

Through a pull request. Fork the repository. Edit the .md file. Open a pull request. File paths map to wiki paths. iris/commands.md is /iris/commands.

Where content comes from

This repository is the source of truth for all plugin documentation. The plugin repositories have no docs/ trees. Edit every page here. That includes numbered plugin pages, landing pages, the BileTools set, HiddenOre operator pages, and home.md.

Each plugin repository has an AGENTS.md file. If a change alters a feature, command, permission, setting, config shape, schema, or API surface, update the matching page here. Make that update in the same workstream.

Frontmatter

---
title: Page Title
description: One-line summary
published: true
date: 2026-08-09T00:00:00.000Z
tags: plugin-name, topic
editor: markdown
dateCreated: 2026-08-09T00:00:00.000Z
---

Update title, description, and tags as needed. Bump date when a page changes and preserve dateCreated.

Conventions

  • Use Wiki.js Page Examples for syntax, renderer features, and prompting patterns.
  • Use Wiki.js CSS & Layout Gallery for heroes, navigation cards, dashboards, timelines, and responsive page compositions.
  • Use absolute internal links such as /iris/commands. Do not use iris/commands.md.
  • Write command syntax as <required> and [optional].
  • Mark a destructive operation with {.is-warning} or {.is-danger}.
  • Wiki.js also supports {.links-list}, {.grid-list}, {.tabset}, {.dense}, and {.is-info} / {.is-success} / {.is-warning} / {.is-danger}.
  • Do not document behavior that you have not verified against the source.

Source branches

Iris, Adapt, and React use the unification branch. They do not use master. The master branches are older. Those branches target earlier Minecraft versions. Gloss, HiddenOre, BileTools, and Wormholes use master.