Skip to main content
Version: GeckoLib5

Contributing to the Wiki

This wiki is open-source and welcomes contributions.
This page acts as the contribution and style guide for contributing to the wiki.

Tooling​

To get started, head to the wiki's GitHub repository.

The README contains instructions on how to set up the wiki locally.

  • Docusaurus – The platform the wiki is built on
  • MDX – The Markdown extension language used to write the content pages
  • React Typescript - Typescript React documentation for dynamic content

Contribution Guidelines​

Submissions​

  • Keep each new page to its own commit, even if bundling multiple pages into a PR.
  • Changes to existing pages should be bundled into a single commit, grouped by change relevance.

New Folders​

New URL subdirectories (folders under /docs/) must abide by the following format rules:

  • Only lowercase letters and hyphens are allowed
  • Each folder must contain a _category_.json file denoting the folder's ordinal in the sidebar, and its display name
  • Code-reference words (E.G. GeoModel, AnimationController) must remain as lowercase, one-word names in file names

New Pages​

  • All document pages must be .mdx files
  • All document page names must be named in lowercase with hyphens as word separators
  • Code-reference words (E.G. GeoModel, AnimationController) must remain as lowercase, one-word names in file names
  • All document pages must explicitly define three properties at a minimum
    • sidebar_position
    • sidebar_label
    • title

Formatting​

  • All code samples must be surrounded in a typed code block
  • `Backticks` must surround all specific notable references:
    • Class names
    • Method names
    • Variable names
    • Menu option names
  • Use bold text to denote important text
  • Use *singular asterisks* to denote italics
  • References to other pages on the wiki must not be repeated within the same page space to avoid overuse.
  • Paragraphs should be broken down into smaller chunks to ensure readability, ideally no more than two contiguous sentences.
  • Line-break <br/> are acceptable for a single-line break, but not for content whitespace.

Content Style​

  • All content must use objective language, using direct references and avoiding personal speech.
  • Anecdotes, culture references, or other non-informational content should be avoided.

Code Samples​

  • The default language for all code samples is java
  • Code samples that add-on to samples prior on the same page should use line-highlighting to denote changed lines.

Code Style​

  • All code samples must be indented with four spaces
  • All instance-fields must be referenced with this.
  • Instance methods should NOT be referenced with this.
  • Open-braces on the same line as the method declaration
  • Close-braces on a new line
  • If-clauses with only a single-line execution may be written without curly braces, on the next line
  • All other if-clauses must use curly braces