Reference

Reference documentation provides precise technical descriptions of the architecture, patterns, and conventions used throughout our codebase. Use these pages as quick lookups when you need to verify naming conventions, file patterns, or API signatures.

Need guidance instead?

If you’re looking for how-to guides, see our Development Patterns section. For concepts and explanations, see Fundamentals.

Naming Conventions

Naming and organizational conventions used throughout the codebase.

• File Organization - Directory structure patterns and file location conventions
• Function Naming - API functions, transforms, and utility naming
• GraphQL Naming - GraphQL file, operation, and fragment naming

File References

Reference documentation for specific file types and their structure.

• api.ts - API function files for GraphQL operations
• transform.ts - Data transformation function files
• transform.types.ts - Transform type definition files
• page.query.graphql - Main page query files
• fragment.graphql - Reusable GraphQL fragment files

Code Conventions

Coding standards and best practices.

• Code Conventions - Coding standards and best practices

Schemas

Type-safe content collection schemas and data structures.

• Content Schemas - Available content collection schemas

---

Note: Reference documentation is meant to be precise and concise. Each page describes “what something is” rather than explaining “why” or “how to use it.” For tutorials and guides, see the Getting Started section.