Matcha Flavoured Wiki:Contributing

From Matcha Flavoured Wiki
Jump to navigation Jump to search

The Matcha Flavoured Wiki is written in a public git repository. The website is built from it, so there is no account to create and nothing to edit in the browser. Anyone with a GitHub account can propose a change, and every change is reviewed as a pull request.

Suggesting a change

Every page has three tabs at the top:

  • Edit on GitHub opens the page's source file in GitHub's editor. Make your change and choose Propose changes. GitHub forks the repository for you and opens a pull request.
  • View source shows the file as it is now.
  • View history lists every commit that changed the page, with the reason for each change.

The footer of every page also names its source file, for example wiki/pages/Main/Oven.wiki.

Some pages are generated from the pack's code, such as short pages for vanilla items and the data behind recipe tables, infoboxes and loot tables. On those pages the tab reads Write this page. It creates a hand-written file at the right path, which replaces the generated page and can still include the generated tables (see Writing). Generated files themselves are never edited by hand: they are rebuilt from the pack's source whenever it updates.

If something is wrong but you don't want to write the fix yourself, open an issue on the repository and say which page, what is wrong and, ideally, which file in the pack shows it.

Writing

Follow the style guide (wiki/STYLE.md in the repository). In short:

  • The wiki follows the Minecraft Wiki's tone and layout: encyclopedic, third person, American English, item names exactly as they appear in game, lowercase in running text.
  • Every fact must be checkable against the pack's code, its official release notes or the developer's design video, in that order. Cite the file you used with <ref>{{Source|MF_datapack/data/...}}</ref>. Information from other wikis, forks or videos is not accepted.
  • Don't copy numbers that the pack's data already provides. Use the generated templates, which update themselves when the pack changes:
    • {{Infobox auto}}: the item infobox;
    • {{Recipes}}, {{Uses}}, {{Sources}}: how an item is made, used and found;
    • {{Data/Trades/Farmer}}, {{Data/Loot/minecraft/chests/simple_dungeon}}, {{Data/Food table}} and similar.
  • Mark secrets with {{Spoiler}}, and content that is only in the development version with {{Upcoming}} or {{Planned}}.

Previewing locally

To see a change before proposing it, clone the repository and follow its README.md. tools/fetch_sources.sh, docker compose up -d and tools/build.sh start a local copy of the wiki at localhost:8080. tools/watch.sh keeps it updated as you save files, and python3 tools/preview.py "Page title" reports template errors and broken links.

How the wiki is built

  • Hand-written pages live in wiki/pages/<Namespace>/<Title>.wiki. A / in a title is written as %2F in the file name.
  • Generated pages in wiki/generated/ are produced by tools/generate.py from the pack's source at the commit pinned in tools/source.lock. A hand-written page with the same title takes precedence.
  • MediaWiki renders every page once at build time, and the result is published as a static site with full-text search. When the pack releases a new version, the sources are updated, the generated pages are rebuilt, and the written pages are reviewed against the new code (the procedure is in the README).

See also

Retrieved from "/index.php?title=Matcha_Flavoured_Wiki:Contributing&oldid=2273"