Skip to content

Setup and Development Guides

This directory contains setup guides, development guidelines, and configuration instructions.

Contents

Development Guidelines

  • DEVELOPMENT_GUIDELINES.md - Main development guidelines
  • COMMON_DEVELOPMENT_TASKS.md - Common development tasks reference
  • ENV_SETUP.md - Environment setup guide
  • ENV_VARIABLES_GUIDE.md - Environment variables guide
  • GITHUB.md - GitHub workflow guide

Getting Started and Quickstart

  • GETTING_STARTED.md - RF Module Designer getting started
  • STANDALONE_STACKUP_QUICKSTART.md - Standalone stackup quickstart
  • FAQ.md - Frequently asked questions

Deployment Guides

  • HOSTINGER_DEPLOYMENT.md - Hostinger deployment
  • HOSTINGER_EMAIL_SETUP.md - Hostinger email setup
  • HOSTINGER_SSH_KEY_SETUP.md - SSH key setup
  • HOSTINGER_SSH_TROUBLESHOOTING.md - SSH troubleshooting
  • FTP_DEPLOYMENT_TROUBLESHOOTING.md - FTP deployment troubleshooting
  • HTTPS_SECURITY_IMPLEMENTATION.md - HTTPS security implementation
  • HTTPS_SETUP_GUIDE.md - HTTPS setup guide

Supabase Setup

  • SUPABASE_ENV_SETUP.md - Supabase environment setup
  • SUPABASE_WEBHOOK_SETUP.md - Webhook configuration
  • SUPABASE_AUTH_TRIGGER_SETUP.md - Authentication trigger setup

Email and Services Setup

  • SENDGRID_SETUP.md - SendGrid configuration
  • AUTH_NOTIFICATIONS_SETUP.md - Authentication notifications

DigiKey Integration

  • get_token_from_browser.md - Token retrieval from browser

Component Guides

  • COMPONENT_PLACEMENT_LAYOUT_RULES.md - Component placement layout rules
  • COMPONENT_UPDATE_GUIDE.md - Component update guide
  • COMPONENT_UPDATE_STEP_BY_STEP.md - Step-by-step component update
  • COMPONENT_VALIDATION_GUIDE.md - Component validation guide

PCB and RF Feature Guides

  • APPLICATION_FREQUENCY_STACKUP.md - Application frequency stackup
  • COPPER_FOILS_PCB.md - Copper foils in PCB
  • COPPER_THICKNESS_ALGORITHM.md - Copper thickness algorithm
  • DRIVER_INPUT_REQUIREMENT_EXPLANATION.md - Driver requirements
  • POWER_HIERARCHY_RULE_EXPLANATION.md - Power hierarchy rules
  • THERMAL-CALCULATORS-GUIDELINES.md - Thermal calculator guidelines
  • SYMBOL_PIN_PLACEMENT_GUIDELINES.md - Symbol pin placement guidelines
  • AI_BLOCK_DIAGRAM_FLOW.md - AI block diagram flow
  • PCB_CHECKER_README.md - PCB checker documentation
  • PCB_Materials_Reference_Table.md - PCB materials reference table
  • ODB_EXPORT_GUIDE.md - ODB++ export guide
  • PLACEMENT_RULES_AUTO_SYNC_GUIDE.md - Placement rules auto-sync
  • SETUP_PLACEMENT_RULES_ENFORCEMENT.md - Placement rules enforcement setup

Testing and Implementation

  • TESTING_INSTRUCTIONS.md - Testing guidelines
  • FULL_WORKFLOW_TESTING.md - Full workflow testing
  • LOCAL_TESTING_GUIDE.md - Local testing guide
  • TROUBLESHOOTING.md - Troubleshooting guide

Documentation and Tools

  • CURSOR_RULES_SYNC_SETUP.md - Cursor rules sync
  • MKDOCS_SETUP.md - MkDocs setup guide
  • MKDOCS_VERSIONING.md - MkDocs versioning
  • GOOGLE_SLIDES_LIMITATION.md - Google Slides limitations
  • METHOD3_SYNC_TO_PUBLIC_TABLE.md - Database sync method

Archived guides

Obsolete/one-time guides (removed tooling, superseded providers, completed migrations, historical analyses) have been moved to docs/archive/guides/. They remain searchable in the docs site but are out of the active index — examples: the DigiKey OAuth prototype guides, HOW_TO_UPDATE_COMPONENT.md (superseded by COMPONENT_UPDATE_GUIDE.md), the Render/MailerSend email setup docs, the client-side PowerPoint/TOC docs (PPTX is now server-side), and the TEST_PLANNING_* build plans.