Skip to content

docs: streamline Copilot CLI launch flow and group reference links - #157

Open
GeekTrainer wants to merge 1 commit into
mainfrom
geektrainer/caldova-jobs-board-spec
Open

docs: streamline Copilot CLI launch flow and group reference links#157
GeekTrainer wants to merge 1 commit into
mainfrom
geektrainer/caldova-jobs-board-spec

Conversation

@GeekTrainer

@GeekTrainer GeekTrainer commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator

Summary

Refines the existing Copilot CLI workshop harness (docs/cli/): folds the "return to / launch Copilot CLI" steps into each lesson's first exercise, groups all mid-file link-reference definitions into a single trailing cluster per file, and removes an unused screenshot.

Note

This PR was originally scoped to also introduce a new Caldova AI Tour edition of the workshop. That work has been parked on the caldova-ai-tour branch to keep it out of the way for now, so this PR is limited to the improvements to the original CLI harness. The Caldova Careers application lives in its own repository (geektrainer/caldova-careers) and is not part of either branch here.

Type of change

  • Workshop content (lesson Markdown, images)
  • Site shell (website/ Astro + Starlight wrapper)
  • Copilot configuration (.github/copilot-instructions.md, instructions, agents, skills)
  • Repo housekeeping (CI, dependabot, README, license)
  • Other:

What's in this PR

  • Launch flow: replaced the standalone "Start a Copilot CLI session" callout with two concrete steps at the top of each lesson's first exercise (return to codespace, resume/relaunch Copilot CLI), and renumbered the following steps.
  • Reference links: moved every mid-file link-reference definition into one contiguous trailing cluster per file.
  • Removed the unused cli-5-agent-skill.png screenshot.

Verification

  • cd website && rm -rf dist && npm run build succeeds
  • Lychee link check passes (0 errors)
  • External GitHub URLs that I changed have been clicked manually (lychee runs offline)

Notes for reviewers

  • Caldova AI Tour content (the docs/cli-caldova/ harness, sidebar entry, cSpell additions, and the refreshed create-from-template screenshot) has been moved to the caldova-ai-tour branch and is intentionally excluded here.

Fold the "return to / launch Copilot CLI" steps into each lesson's first
exercise instead of a standalone callout, move all mid-file link-reference
definitions into a single trailing cluster per file, and drop the unused
agent-skill screenshot.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 7fd1673d-806b-4db8-bffd-9841a406d247
Copilot AI review requested due to automatic review settings July 27, 2026 22:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Caldova-themed Copilot CLI workshop harness under docs/cli-caldova/ and updates the existing docs/cli/ harness to use a more consistent lesson structure (inlining “return to/start Copilot CLI” steps and consolidating link references), with the new harness wired into the Starlight sidebar.

Changes:

  • Introduces a full 0–8 Caldova CLI lesson set plus overview (docs/cli-caldova/).
  • Refactors several existing CLI lessons to remove the standalone “start Copilot CLI session” callout and standardize link-reference placement.
  • Updates the Starlight sidebar (website/astro.config.mjs) and extends cSpell words (.vscode/settings.json).
Show a summary per file
File Description
website/astro.config.mjs Adds the new Caldova CLI section to the Starlight sidebar.
docs/cli/README.md Moves link references to the bottom for consistency.
docs/cli/0-prerequisites.md Moves link references to the bottom for consistency.
docs/cli/2-custom-instructions.md Reworks “start session” guidance into numbered steps and consolidates references at the end.
docs/cli/3-generating-code.md Replaces the session-start callout with inline steps for returning to Copilot CLI.
docs/cli/4-mcp.md Replaces the session-start callout with inline steps and consolidates references at the end.
docs/cli/5-agent-skills.md Adds a “Creating agent skills” section and replaces the session-start callout with inline steps.
docs/cli/6-custom-agents.md Replaces the session-start callout with inline steps and consolidates references at the end.
docs/cli/7-slash-commands.md Replaces the session-start callout with inline steps and updates step numbering.
docs/cli-caldova/README.md New Caldova CLI harness overview/landing page.
docs/cli-caldova/0-prerequisites.md New Caldova Exercise 0 (create-from-template + codespace setup).
docs/cli-caldova/1-install-copilot-cli.md New Caldova Exercise 1 (install/auth Copilot CLI).
docs/cli-caldova/2-custom-instructions.md New Caldova Exercise 2 (instructions workflow and branching).
docs/cli-caldova/3-generating-code.md New Caldova Exercise 3 (plan mode + generating the filtering feature).
docs/cli-caldova/4-mcp.md New Caldova Exercise 4 (add Playwright MCP + test feature).
docs/cli-caldova/5-agent-skills.md New Caldova Exercise 5 (agent skills and PR workflow skill).
docs/cli-caldova/6-custom-agents.md New Caldova Exercise 6 (custom agents + accessibility scenario).
docs/cli-caldova/7-slash-commands.md New Caldova Exercise 7 (slash commands, sharing, model selection, delegation).
docs/cli-caldova/8-review.md New Caldova Exercise 8 (wrap-up and resources).
.vscode/settings.json Adds Caldova-related terms to the cSpell dictionary.

Review details

  • Files reviewed: 20/22 changed files
  • Comments generated: 4
  • Review effort level: Low

Comment thread docs/cli-caldova/0-prerequisites.md Outdated

To create a copy of the repository for the code you'll create, you'll make an instance from the [template][template-repository]. The new instance will contain all of the necessary files for the lab, and you'll use it as you work through the exercises.

1. In a new browser window, navigate to the GitHub repository for this lab: `https://github.com/geektrainer/caldova-careers`.
Comment thread docs/cli-caldova/4-mcp.md Outdated
lastUpdated: 2026-06-30
---

You just generated the filtering feature with Copilot CLI. Before you open a pull request, you should confirm it works in the browser. Rather than click through the app yourself, you'll connect the **Playwright MCP server** and let Copilot drive a real browser to test the feature for you.
[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools
1. In the prompt window for Copilot CLI, send the following command:
1. Return to your codespace. If you closed it, navigate to your repository on GitHub.com, select **Code** > **Codespaces**, then reopen your existing codespace.
2. Return to your open Copilot CLI session. If the terminal is closed or you exited Copilot CLI, open a terminal by selecting <kbd>Ctrl</kbd>+<kbd>\`</kbd>, then start it from the repository root by running `copilot --yolo --enable-all-github-mcp-tools`. Trust the project folder if prompted, then run `/models` and select **Auto**.
Comment thread docs/cli-caldova/7-slash-commands.md Outdated
Let's create a GitHub gist we could share with our team.

1. Return to your codespace. If you closed it, navigate to your repository on GitHub.com, select **Code** > **Codespaces**, then reopen your existing codespace.
2. Return to your open Copilot CLI session. If the terminal is closed or you exited Copilot CLI, open a terminal by selecting <kbd>Ctrl</kbd>+<kbd>\`</kbd>, then start it from the repository root by running `copilot --yolo --enable-all-github-mcp-tools`. Trust the project folder if prompted, then run `/models` and select **Auto**.
@GeekTrainer
GeekTrainer force-pushed the geektrainer/caldova-jobs-board-spec branch from 1345e49 to 0fd0011 Compare July 28, 2026 21:39
@GeekTrainer GeekTrainer changed the title docs: add Caldova AI Tour edition of the Copilot CLI workshop docs: streamline Copilot CLI launch flow and group reference links Jul 28, 2026
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.

2 participants