Wiki
  • Homepage
  • Player's Manual
    • Controls
    • Skills
    • Objects
    • Credits
  • Contributing
    • Getting Started
      • Programs and Files
      • Cloning the GitHub Project
      • Git Structure
      • Submitting Changes
    • Level Design
      • Basic Level Setup
      • Creating Static.tscn
      • Creating Collision.tscn
      • Stage Triggers
        • Using StageTrigger.tscn
        • Camera Triggers
        • Culling Triggers
        • Death Triggers
        • Dialog Triggers
        • Jump Triggers
        • Path Triggers
        • Automation Triggers
        • Drift Triggers
        • Foothold Triggers
        • Platform Triggers
        • Sidle Triggers
      • Stage Objects
      • Placing Objects Along the Path
    • Playtesting
      • General Shortcuts
      • Debug Menu
      • Free Camera Mode
      • Using the Editor for Playtesting
    • Submitting a Bug Report
    • Documentation Style Guide
  • Asset Guidelines
    • Source Files
    • Asset Ripping Reference
      • Original Model Files
    • Asset Editing Reference
      • Editing Environment Models
      • Editing Collision Models
      • All About Curves
      • Exporting Models from Blender
    • Resources Files
      • CameraSettingsResource
    • Miscellaneous Notes
  • Godot Guidelines
    • File Guides
      • File Structure
      • Naming Files
    • Project Settings
      • Tag Reference
      • Layer Reference
    • Particle Effects
    • Audio
  • CODE GUIDELINES
    • Language Specifications
    • Formatting
    • General guidelines
    • Attributes
    • Floating Point Numbers
Powered by GitBook
On this page
  1. Contributing

Documentation Style Guide

This page contains information about how documentation wiki text should be formatted.

  • Inputs should be in CAPS and surrounded by [square brackets] - Press [SPACE].

  • File extensions should be in italics - .tres, .blend, etc.

  • Selections and onscreen directions should be in quotes - Select "Selection."

  • Directions should be given step-by-step using arrows - Go to "File -> Open" and locate your file.

  • Notes should be expressed with parentheses - Explanation here (Note here).

  • Explanations in bullet points should be proceeded by a hyphen - As done here.

  • Bullet points should end with proper punctuation.

  • References to uncreated pages should be followed by (refneeded).

PreviousSubmitting a Bug ReportNextSource Files

Last updated 12 months ago