Skip to content

Comments

Add comprehensive GitHub Copilot instructions for Inalia docs repository#11

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/fix-10
Draft

Add comprehensive GitHub Copilot instructions for Inalia docs repository#11
Copilot wants to merge 2 commits intomainfrom
copilot/fix-10

Conversation

Copy link
Contributor

Copilot AI commented Sep 7, 2025

Created a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the Inalia documentation repository.

What's Included

The instructions provide validated commands and workflows for:

  • Prerequisites and setup: Node.js v20+ and pnpm installation requirements
  • Bootstrap workflow: pnpm install (~6 seconds) and pnpm run build (~4-5 seconds)
  • Development commands: pnpm run dev (localhost:5174) and pnpm run preview
  • Manual validation scenarios: Browser testing requirements for all documentation pages
  • Project structure: Complete file/directory layout with descriptions
  • Troubleshooting guidance: Common issues and solutions

Key Features

  • Imperative tone: All commands are written as direct instructions ("Run this", "Do not do that")
  • Validated timing: Every command was tested and timed during creation
  • Manual testing requirements: Specific browser validation scenarios for homepage, getting started, and static mode pages
  • No unnecessary warnings: Since build times are extremely fast (4-5 seconds), no "NEVER CANCEL" warnings were needed
  • Complete project context: Covers VitePress configuration, content structure, and external integrations

Repository Characteristics Documented

The instructions capture this repository's unique characteristics:

  • VitePress 1.6.4 documentation site for the Inalia presentation tool
  • Extremely fast build times due to minimal content
  • No existing testing, linting, or CI/CD infrastructure
  • Simple content structure focused on Slidev integration guidance
  • Uses pnpm as the package manager with version 10.14.0

Inalia Documentation Homepage

The instructions enable any GitHub Copilot agent to immediately start working effectively in this codebase without requiring additional exploration or setup time.

Fixes #10.


💡 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
Copy link

cloudflare-workers-and-pages bot commented Sep 7, 2025

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7719d31
Status: ✅  Deploy successful!
Preview URL: https://e964e2a2.docs-9wh.pages.dev
Branch Preview URL: https://copilot-fix-10.docs-9wh.pages.dev

View logs

Co-authored-by: Barbapapazes <45267552+Barbapapazes@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for Inalia docs repository Sep 7, 2025
Copilot AI requested a review from Barbapapazes September 7, 2025 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants