Reference

Reference

Reference documentation provides dry, technical descriptions and specifications. This is where you look up exact details about configuration options, parameters, and system behavior.

What is reference documentation?

Reference pages:

• Describe technical details: Exact specifications and options
• Are comprehensive: Cover all possibilities
• Are accurate: Provide precise, verified information
• Are structured: Organized for easy lookup
• Are factual: No opinions or explanations, just facts

When to use reference

Use reference documentation when you need to:

• Look up specific parameters or configuration options
• Find exact syntax for a feature
• Check what values are allowed for a property
• Understand system limitations
• See all available options for a feature

Reference vs. other documentation

• Not a tutorial: Won't teach you how to use features
• Not a how-to: Won't guide you through tasks
• Not an explanation: Won't discuss concepts or reasoning

Reference is for looking things up, not for learning or understanding.

Available reference documentation

API Reference

Complete technical reference for platformOS APIs

Liquid Markup

Liquid (or Liquid markup) is a template language used in platformOS to build dynamic pages and provide dynamic configuration.

Our complete Liquid reference includes:

• Introduction - Getting started with Liquid
• Types - Data types in Liquid
• Tags - All Liquid tags including platformOS-specific
• Filters - All Liquid filters including platformOS-specific
• Objects - Liquid objects and platformOS objects
• Whitespace Control - Managing whitespace
• Sanitization - Security and sanitization

GraphQL API

GraphQL is the query language used to communicate with platformOS data storages.

Our GraphQL reference includes:

• Glossary - GraphQL terminology
• Queries - Data retrieval operations
• Mutations - Data modification operations
• Objects, Scalars, Interfaces, Enums, and Inputs

---

Configuration & Specifications

Reserved Names & System Defaults

• Reserved Names and Defaults - Overview
• Reserved URLs - URLs you cannot use
• Reserved Directories - System directory names
• Deprecated Directories - Old directory structure
• Reserved Parameters - Parameter names
• Defaults - System default values

JSON Documents

• Distance Units - Geolocation distance units

Tools & Validation

• platformOS Check - Code quality checker

System Information

• Limitations - Platform limitations and constraints
• Glossary - Terminology and definitions
• Support & Ticketing - Getting help

Not finding what you need?

• Want to learn? → Start with Tutorials
• Need to accomplish a task? → Check How-to Guides
• Want to understand concepts? → Read Explanations

---

This documentation follows the Diataxis framework for organizing technical documentation.