getting-started-docs

---

description: How to add or edit Cursor rules in our project globs: alwaysApply: false

Getting Started Documentation Standards

This document defines the standards and guidelines for creating and maintaining Getting Started documentation in the Substance 3D API documentation.

Document Structure

Frontmatter

Every Getting Started document must include the following frontmatter:

---
title: [Clear, Action-Oriented Title]
description: [Concise description of the guide's purpose]
hideBreadcrumbNav: true
keywords:
  - [Relevant keyword 1]
  - [Relevant keyword 2]
---

Contributors Field

• Do NOT add contributors

Section requirements

1. Title (H1)

   • Use clear, action-oriented titles
   • Avoid "How to" or "Guide to" prefixes
   • Example: "Authentication" instead of "How to Authenticate"

2. Overview (H2)

   • Brief introduction (2-3 sentences)
   • Clear statement of what the reader will learn
   • No code examples in this section

3. Prerequisites (H2) - Optional

   • Only include if there are specific requirements needed before starting
   • Not required for quickstart guides or simple reference documentation
   • When included, should contain:
     • Bulleted list of requirements
     • Links to related documentation
     • Required accounts, credentials, or tools
   • Example for when prerequisites are needed:

     ## Prerequisites
     
     This tutorial assumes you have:
     - An [Adobe Developer Console][1] account
     - A project with [required credentials][2]
     - [Required tool or software][3]
     

4. Main Content (H2+)

   • Use clear, hierarchical headings (H2 → H3 → H4)
   • Include practical examples
   • Follow step-by-step format for tutorials
   • Use code blocks with language specification

5. Code Examples

   • Use triple backticks with language specification
   • Include comments explaining complex operations
   • Show both request and response examples
   • Example:

     ```bash
     # Export credentials as environment variables
     export CLIENT_ID=<your_client_id>