Reference Documentation

This section contains reference materials, technical specifications, and conceptual documentation for the Forge platform.

📚 Reference Categories

• 🏗️ Architecture - Platform structure, the Golden Path, and authentication mechanics
• 📋 Decisions - Accepted architectural and convention decisions
• 🧰 CLI commands - Generated command syntax and options
• 🧭 CLI workflows - Authentication, publishing, search, and operational constraints
• 🤖 Smithy - Shared assistant and MCP contract
• 📦 Terraform Modules - Generated module reference from source READMEs
• 🧾 @saif/platform-typespec - Operation templates, status-code models, auth helpers, and eventing contracts for API contracts
• 📦 .NET Packages - Generated reference documentation for Forge's .NET packages, sourced from each package's README.md under src/dotnet/
• 📦 TypeScript Packages - Generated reference documentation for Forge's TypeScript packages, sourced from each package's README.md under src/typescript/packages/
• 📊 Version Compatibility Matrix - Framework versions, breaking changes, and migration guides
• 🌍 Environments - Environment configurations, deployment flows, and approvers
• 🚀 Pipelines - What each .azdo pipeline does, what triggers it, and which one to run
• 🔎 Read pipeline logs - Log selection, filters, and cross-job investigation
• 🧭 Service ↔ Azure Resource Model - How a service maps to live Azure resources: naming invariant, subscription topology, resource discovery, and tag contract
• 🔐 Security - Authentication, authorization, and security patterns
• 📝 Documentation Authoring - Answer-first troubleshooting page shape, metadata, and validation guidance
• 🔎 Documentation Retrieval - Provider chain, multi-site MkDocs fallback, location resolution rules, AI Search filter contract, and the evaluation harness
• 🏷️ Tags - Browse documentation by component and topic