Skip to content

Commit 3f59cd2

Browse files
GeekTrainerCopilot
andcommitted
fix: correct Exercise 1 numbering and align partials convention with practice
- cli/1-install-copilot-cli.mdx: title was 'Exercise 2' and the next-lesson sentence pointed to 'Exercise 3'. The CLI overview correctly lists this lesson as Exercise 1 and the next as Exercise 2. Renumber both. Workshop/ regenerated to match. - partials.instructions.md: previous guidance said callout partials must NOT import Aside (host page imports it). Every existing callout-*.mdx contradicts this — they all import Aside themselves. Reverse the guidance to match practice: callout partials are self-contained and import their own Starlight components. Both findings surfaced in Copilot's PR review on #140. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent a6e7fc9 commit 3f59cd2

3 files changed

Lines changed: 14 additions & 6 deletions

File tree

.github/instructions/partials.instructions.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,14 @@ If a partial drops into the middle of a numbered list, write its items as plain
4545
1. Third step.
4646
```
4747

48-
## No `<Aside>` imports inside callout partials
48+
## Imports inside callout partials
4949

50-
When the partial *is* a single `<Aside>`, the import for `Aside` lives in the host MDX page. The partial just contains the JSX. (Imports inside partials are allowed but the convention is to keep partials minimal.)
50+
Callout partials should be **self-contained**: import any Starlight component they use (typically `Aside`) at the top of the partial itself, rather than expecting the host page to provide the import. This matches how every existing `callout-*.mdx` is written and means a host page can drop in a callout partial without remembering to also add an `import { Aside } ...` line.
51+
52+
```mdx
53+
import { Aside } from '@astrojs/starlight/components';
54+
55+
<Aside type="tip" title="Start a Copilot CLI session">
56+
57+
</Aside>
58+
```

docs/src/content/docs/cli/1-install-copilot-cli.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Exercise 2 - Installing GitHub Copilot CLI"
2+
title: "Exercise 1 - Installing GitHub Copilot CLI"
33
---
44

55
import { Aside } from '@astrojs/starlight/components';
@@ -106,7 +106,7 @@ Congratulations! You've successfully installed and authenticated GitHub Copilot
106106
- trust a directory for Copilot CLI to work with.
107107
- verify the installation is working correctly.
108108

109-
Now that Copilot CLI is installed, let's see how it picks up your repository's custom instructions. Continue to [Exercise 3 - Custom instructions hands-on][next-lesson].
109+
Now that Copilot CLI is installed, let's see how it picks up your repository's custom instructions. Continue to [Exercise 2 - Custom instructions hands-on][next-lesson].
110110

111111
## Resources
112112

workshop/cli/1-install-copilot-cli.md

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)