Add comprehensive GitHub Copilot instructions for unionai-docs repository

[Copilot]

This PR adds a comprehensive .github/copilot-instructions.md file that provides detailed guidance for GitHub Copilot coding agents working with the unionai-docs repository.

Overview

The instructions file covers the complete development workflow from initial setup to production deployment, with emphasis on the unique requirements and challenges of this Hugo-based documentation site.

Key Features

Critical Requirements Documented:

• Hugo v0.145.0+ requirement with manual installation steps (Ubuntu apt only provides v0.123.7)
• Git submodule configuration workaround for SSH access issues in CI environments
• Multi-variant build system for different product documentation (Flyte, BYOC, Serverless, Self-managed)

Complete Workflow Coverage:

• Bootstrap process with exact commands and URLs
• Development server setup and usage (make dev at localhost:1313)
• Production builds for all variants (make dist - completes in under 2 seconds)
• Validation commands for images, Jupyter notebooks, and build integrity

Timing and Safety Guidance:

• Documented build times with "NEVER CANCEL" warnings
• Appropriate timeout recommendations (2+ minutes for builds, 15+ minutes for submodule init)
• Manual testing scenarios with specific navigation paths to verify functionality

Developer Experience:

• Repository structure reference for quick navigation
• Hugo configuration system explanation
• Variant-specific content authoring guidelines
• Known issues and workarounds section

Validation

All documented commands have been tested and validated:

• ✅ Hugo installation and version verification
• ✅ Submodule initialization with HTTPS workaround
• ✅ Development server functionality with hot-reload
• ✅ Production builds for all variants (timing measured)
• ✅ Manual navigation testing across all main sections
• ✅ Image and Jupyter notebook validation commands

The development server was manually tested and verified working correctly:

The instructions follow imperative tone requirements and provide exhaustive validation steps to ensure reliable operation for any GitHub Copilot coding agent working with this repository.

Fixes #489.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• esm.ubuntu.com
  • Triggering command: /usr/lib/apt/methods/https (dns block)
• github.com (HTTP Only)
  • Triggering command: /usr/bin/ssh -o SendEnv=GIT_PROTOCOL [email protected] git-upload-pack 'unionai/unionai-examples' (packet block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[cloudflare-workers-and-pages]

Deploying docs with    Cloudflare Pages

Latest commit:	d729200
Status:	✅  Deploy successful!
Preview URL:	https://7373a707.docs-dog.pages.dev
Branch Preview URL:	https://copilot-fix-489.docs-dog.pages.dev

View logs