Skip to content
This repository was archived by the owner on Dec 29, 2025. It is now read-only.

Commit 1382e20

Browse files
chore: add basic instructions for copilot coding agent
1 parent 8b1e0e1 commit 1382e20

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

.github/copilot-instructions.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Copilot Instructions for meshStack Documentation
2+
3+
This is a Docusaurus v3 project. Follow these guidelines when making changes.s
4+
5+
## Before Making Changes
6+
7+
**Read relevant instruction files** based on your task:
8+
9+
Always obey the following:
10+
- [tone instructions](instructions/tone.instructions.md)
11+
- [capitalization and wording instructions](instructions/capitalizationandwording.instructions.md)
12+
13+
The following applies to specific file types:
14+
- Instructions for [writing guides](instructions/guide.instructions.md)
15+
16+
## Before Committing
17+
18+
Always run these commands to validate your changes:
19+
20+
```bash
21+
yarn lint # Check for documentation errors
22+
yarn build # Ensure the site builds correctly
23+
```
24+
25+
Do not commit if either command fails.
26+
27+
## Key Commands
28+
29+
- `yarn start` - Development server
30+
- `yarn build` - Production build
31+
- `yarn lint` - Run all linters
32+
- `yarn typecheck` - TypeScript validation
33+
34+
## Project Structure
35+
36+
- `docs/` - Documentation files
37+
- `blog/` - Blog posts
38+
- `static/` - Static assets
39+
- `src/` - Source code
40+
- `docusaurus.config.ts` - Main configuration
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: "Copilot Setup Steps"
2+
3+
# Automatically run the setup steps when they are changed to allow for easy validation, and
4+
# allow manual testing through the repository's "Actions" tab
5+
on:
6+
workflow_dispatch:
7+
push:
8+
paths:
9+
- .github/workflows/copilot-setup-steps.yml
10+
11+
jobs:
12+
# The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
13+
copilot-setup-steps:
14+
runs-on: ubuntu-latest
15+
16+
permissions:
17+
contents: read
18+
19+
# You can define any steps you want, and they will run before the agent starts.
20+
# If you do not check out your code, Copilot will do this for you.
21+
steps:
22+
- name: Checkout code
23+
uses: actions/checkout@v4
24+
25+
- name: Set up Node.js
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: "18.x"
29+
cache: "yarn"
30+
cache-dependency-path: "**/yarn.lock"
31+
32+
- name: Install dependencies
33+
run: yarn install --frozen-lockfile
34+
35+

0 commit comments

Comments
 (0)