Gigantic Wiki:Practices and processes

From Gigantic Wiki
Jump to navigation Jump to search

Follow these guidelines in order to ensure consistency and quality throughout the wiki.

Main Page

Use the editcopy to propose and test changes to the main page.

Categories and Nav Boxes

Always make sure to categorize new pages and files, and add nav boxes at the bottom of new pages.

  • These two features connect the wiki together and make it much easier to navigate and maintain.

Preserve Game Files

When uploading raw game files such as images, do not edit them or change their filenames (allow the wiki to replace spaces with underscores).

  • This simplifies the process of updating these files for new versions of the game.

Test Numbers and Effects

Information on hero skills should be tested and confirmed, do not just copy the in-game tooltips.

  • Our goal is for this wiki to provide complete and accurate information, not to simply replicate what is available in game.

Editing Grammar

Grammar edits should be limited to fixing mistakes and improving clarity.

  • Do not change the meaning of a sentence.
  • Do not replace words with similar words that don't convey the same meaning, especially if the original words are clear and accurate ('strong choice' vs 'valuable option').
  • Do not capitalize game terms unless they need to be capitalized (burn, focus, attack, skill, health, shield, etc.)

Test on both Desktop and Mobile

When creating larger content, check how the layout appears on both high resolution desktop screens and low resolution phone displays.

  • Ctrl+Shift+M is a keyboard shortcut that works on both Chrome and Firefox to go into a mode that tests different resolutions.
    • The same shortcut will disable the mode when you are done.

Quick Load Times

Wherever possible aim to reduce load times, especially on the main page.

  • Avoid using a ton of separate images.
    • On the main page we do this by combining the heroes, maps, and creatures into their own compact images, which turns 40 individual images into 3.
    • Some pages do need to use a ton of images, such as the list of all heroes, or all badges, but in these cases keep to one image per table entry.

Easy to Edit

Make use of templates, css, and html tags, but avoid making them overly complex.

  • It is preferable to have a system that is simple and easy for new contributors to pick up instead of one that is highly technical and requires a lot of digging through code.
  • A single template should not be a swiss army knife that does everything, but instead should have a clear purpose like a tool in a toolbox.

Dark Mode

This site has a dark mode theme and is meant to be friendly to users who are in a dark room.

  • Avoid using large amounts of bright colors, especially bright blue, and keep with the existing 'Moonlight' theme when possible.