Skip to content

Commit df9d649

Browse files
Copilotmikebarkmin
andcommitted
Format copilot-instructions.md with Prettier
Co-authored-by: mikebarkmin <[email protected]>
1 parent bdf6269 commit df9d649

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ pnpm dev # Watch mode for development
6060
### Package Scripts
6161

6262
Each package has its own scripts defined in its `package.json`:
63+
6364
- `build`: Compiles TypeScript and bundles with esbuild
6465
- `lint`: Type-checks with TypeScript (tsc --noEmit)
6566
- `test`: Runs tests with Vitest
@@ -91,6 +92,7 @@ Each package has its own scripts defined in its `package.json`:
9192
### Translations
9293

9394
The project supports internationalization (i18n):
95+
9496
- Translations are defined in `packages/learningmap/src/translations.ts`
9597
- Use the `getTranslations(language)` helper
9698
- Default language is English (`en`), German (`de`) is also supported
@@ -110,10 +112,12 @@ The project supports internationalization (i18n):
110112
### Working with the Editor
111113

112114
The core editor (`LearningMapEditor`) has two modes:
115+
113116
- **Edit Mode**: Full editing capabilities with toolbar
114117
- **Preview Mode**: View-only mode for testing the learner experience
115118

116119
Key components:
120+
117121
- `EditorToolbar`: Main menu and controls
118122
- `EditorDrawer`: Side panel for node/edge editing
119123
- Node types: `TopicNode`, `TaskNode`, `TextNode`, `ImageNode`
@@ -136,6 +140,7 @@ Key components:
136140
## Documentation
137141

138142
Documentation is built with Hyperbook and located in the `docs/` directory:
143+
139144
- `docs/book/index.md`: Main documentation entry
140145
- `docs/book/development.md`: Development guide
141146
- `docs/book/contributing.md`: Contribution guidelines
@@ -144,11 +149,13 @@ Documentation is built with Hyperbook and located in the `docs/` directory:
144149
## CI/CD
145150

146151
GitHub Actions workflows:
152+
147153
- `pull-request.yml`: Runs tests and build on PRs
148154
- `changeset-version.yml`: Manages version bumps and releases
149155
- `docs.yml`: Deploys documentation
150156

151157
All PRs must pass:
158+
152159
1. TypeScript type checking (`pnpm lint`)
153160
2. Tests (`pnpm test`)
154161
3. Build (`pnpm build`)
@@ -165,6 +172,7 @@ All PRs must pass:
165172
## Dependencies
166173

167174
When adding new dependencies:
175+
168176
- Add to the appropriate package's `package.json`
169177
- Use `pnpm add <package>` in the package directory
170178
- Consider bundle size impact for the web component

0 commit comments

Comments
 (0)