Skip to content

Commit c0868ac

Browse files
authored
Merge pull request #264 from orionrobots/improve-copilot-instructions
Update copilot-instructions.md
2 parents ae9f95a + 47ed8f0 commit c0868ac

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

.github/copilot-instructions.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,14 @@ Orionrobots is a static website about robotics using Eleventy (11ty) static site
1212
- Build assets and site manually:
1313
- `docker compose run dist` -- builds webpack bundle.js, takes ~30 seconds
1414
- `docker compose run build` -- builds full static site, takes ~3 minutes. Set timeout to 240+ seconds.
15-
- Alternative native workflow:
16-
```bash
17-
npm install
18-
npm run dist
19-
npm run 11ty
20-
```
2115

2216
### Development Server
2317
- Run local development server:
2418
- `docker compose up serve` -- starts Eleventy dev server on port 8081, **NEVER CANCEL** - builds then watches files. Set timeout to 300+ seconds for initial build.
25-
- Alternative native: `npm run serve` -- starts Eleventy dev server directly
26-
- Manual serving: After building, serve with Python: `cd _site && python3 -m http.server 8082`
2719

2820
### Testing Commands
2921
- BDD integration tests:
3022
- `docker compose run test` -- runs Cucumber.js tests with Playwright in containerized environment
31-
- Alternative native: `npm run test:bdd` or `npm test` -- runs tests directly on host
3223
- **Note**: Playwright installation may fail in some CI environments
3324
- Tests require a running staging server to test against
3425

@@ -49,7 +40,6 @@ Always test these key pages that are verified in CI:
4940

5041
### Build Verification
5142
- Run `docker compose run dist && docker compose run build` and verify `_site` directory is created with content
52-
- Alternative native: `npm run dist && npm run 11ty`
5343
- Check that `_site/index.html` exists and contains proper HTML structure
5444
- Verify `dist/bundle.js` exists and is approximately 330KB
5545

@@ -68,6 +58,7 @@ dist/ -- Webpack build output (bundle.js)
6858
docker-compose.yml -- Docker development environment setup
6959
package.json -- npm dependencies and scripts
7060
src/ -- Source files for Webpack
61+
tests/staging -- Gherkin-based BDD tests for website functionality
7162
webpack.config.js -- Webpack configuration
7263
```
7364

@@ -79,16 +70,13 @@ webpack.config.js -- Webpack configuration
7970
## Build Process Details
8071

8172
### Build Order (Critical)
82-
1. **Webpack Build** (`docker compose run dist` or `npm run dist`): Creates `dist/bundle.js` with CSS and JS assets
83-
2. **Eleventy Build** (`docker compose run build` or `npm run 11ty`): Processes markdown, creates HTML, copies assets to `_site/`
73+
1. **Webpack Build** (`docker compose run dist`): Creates `dist/bundle.js` with CSS and JS assets
74+
2. **Eleventy Build** (`docker compose run build`): Processes markdown, creates HTML, copies assets to `_site/`
8475

8576
### Timing Expectations
8677
- Docker compose up: ~4-5 minutes for initial build and start (set 300+ second timeout)
8778
- Docker dist build: ~30 seconds (set 60+ second timeout)
8879
- Docker site build: ~3 minutes (**NEVER CANCEL** - set 240+ second timeout)
89-
- Alternative native npm install: ~1 minute (standard timeout OK)
90-
- Alternative native webpack dist: ~7 seconds (set 30+ second timeout)
91-
- Alternative native Eleventy build: ~2.5 minutes (**NEVER CANCEL** - set 180+ second timeout)
9280

9381
### Known Build Warnings
9482
- Sass deprecation warnings about @import rules (normal, build continues)
@@ -132,6 +120,9 @@ This creates properly structured content with frontmatter in `content/YYYY/MM/`
132120
- CSS/JS: Add to `src/` and import in `src/index.js`
133121
- Static files: Use Eleventy passthrough copy in `.eleventy.js`
134122

123+
### Adding scripts or utilities
124+
- Ensure these are run through a docker compose command
125+
135126
### Troubleshooting Build Issues
136127
1. Clear containers and rebuild: `docker compose down && docker compose build --no-cache`
137128
2. Clear build outputs: `docker compose run --rm base rm -rf _site dist`
@@ -162,4 +153,4 @@ This is a Jekyll-to-Eleventy migrated project (now fully Eleventy) with:
162153
- Extensive robotics content and tutorials
163154
- Apache hosting with custom htaccess rules
164155

165-
**CRITICAL REMINDER**: Use Docker Compose as the primary development method. Never cancel long-running builds - they can take 3-5+ minutes for initial setup.
156+
**CRITICAL REMINDER**: Use Docker Compose as the primary development method. Never cancel long-running builds - they can take 3-5+ minutes for initial setup.

0 commit comments

Comments
 (0)