Skip to content

docs: correct workshop safety and setup guidance - #211

Merged
GeekTrainer merged 1 commit into
mainfrom
geektrainer/correct-workshop-source-guidance
Nov 13, 2026
Merged

GeekTrainer merged 1 commit into
mainfrom
geektrainer/correct-workshop-source-guidance

Conversation

@GeekTrainer

Copy link
Copy Markdown
Collaborator

Summary

Correct 20 source lesson pages so learners review publication/deployment actions before authorizing them and receive current, client-specific setup guidance.

  • Move the existing public-repository publishing warning before the action prompt, preserving its wording.
  • Separate Pages workflow/PR preparation from human review, explicit merge/deploy authorization, and live-site verification.
  • Distinguish initial GitHub.com/GHE.com sign-in from adding a GitHub Enterprise Server account after onboarding; use the documented Enterprise Cloud sign-in label.
  • Correct CLI /init guidance to allow no arguments or optional instructions, preserving the working example prompt.

Publishing, account setup, and CLI corrections cover English plus all five existing locales (es-es, ja-jp, ko-kr, pt-br, zh-cn). Pages changes cover the existing English and Korean lessons; no absent translations were added.

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:

Verification

  • Type checks and a clean site build pass.
  • Affected pages and translations match their source and intended routes.
  • Offline internal link checks pass.
  • Changed external links have been checked separately.

bash .github/skills/build-and-verify-docs/scripts/verify.sh — passed, including npm run check:all, the clean npm run build, and offline Lychee with zero link errors. git diff --check — passed before commit.

Source-to-HTML comparisons passed for all 20 changed pages: locale, title, headings, prompts, warning order, and changed links. A nine-route Playwright smoke check covered the landing page, changed lessons including Korean Pages, and all four real-world-development environments: all returned HTTP 200, with no console errors, broken images, or raw admonition markers. Both changed external documentation URLs returned HTTP 200 and were checked against their documented behavior. Content alignment and localization review passed for the scoped corrections.

Screenshots

N/A — lesson wording and action order only; no site styling or layout changes.

Notes for reviewers

The app's own lesson 4 and its translations retain the existing Command input required claim. The app slash-command reference lists /init but does not establish that error behavior; the CLI reference is not evidence for app or VS Code behavior.

The Enterprise Server sign-in guide and app quickstart support the account setup correction. No interactive sign-in, repository publication, or Pages deployment was performed during validation.

The package manifest, lockfile, site configuration, and unrelated lesson content are unchanged. Existing schema deprecation hints, the empty i18n collection build warning, and plain-div admonition styling are outside this change.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings November 13, 2026 17:58

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.

🟢 Approval recommended

No active review issues are outstanding for the documentation updates clarifying setup guidance and publishing safeguards.

No open issues 🎉

What changed in this PR

This PR updates 20 workshop lesson pages to put safety guidance before publishing actions and clarify client-specific setup behavior, without changing the site shell.

Changes:

  • Move existing publication warnings before action prompts in English and all five locales.
  • Split Pages deployment into preparation, human review, explicit authorization, and verification in English and Korean.
  • Correct app account setup and CLI /init guidance across all six languages.
File Description
docs/​zh-cn/​real-world-development/​app/​1-install-copilot-app.md Correct Chinese cloud and Enterprise Server sign-in guidance.
docs/​zh-cn/​first-steps/​copilot-cli/​2-project-instructions.md Clarify optional /init instructions in Chinese.
docs/​zh-cn/​first-steps/​copilot-app/​5-publish.md Move Chinese warning before publication prompt.
docs/​real-world-development/​app/​1-install-copilot-app.md Correct English cloud and Enterprise Server sign-in guidance.
docs/​pt-br/​real-world-development/​app/​1-install-copilot-app.md Correct Portuguese cloud and Enterprise Server sign-in guidance.
docs/​pt-br/​first-steps/​copilot-cli/​2-project-instructions.md Clarify optional /init instructions in Portuguese.
docs/​pt-br/​first-steps/​copilot-app/​5-publish.md Move Portuguese warning before publication prompt.
docs/​ko-kr/​real-world-development/​app/​1-install-copilot-app.md Correct Korean cloud and Enterprise Server sign-in guidance.
docs/​ko-kr/​first-steps/​copilot-cli/​2-project-instructions.md Clarify optional /init instructions in Korean.
docs/​ko-kr/​first-steps/​copilot-app/​5-publish.md Move Korean warning before publication prompt.
docs/​ko-kr/​first-steps/​copilot-app/​12-deploy-pages.md Separate Korean deployment preparation, review, authorization, and verification.
docs/​ja-jp/​real-world-development/​app/​1-install-copilot-app.md Correct Japanese cloud and Enterprise Server sign-in guidance.
docs/​ja-jp/​first-steps/​copilot-cli/​2-project-instructions.md Clarify optional /init instructions in Japanese.
docs/​ja-jp/​first-steps/​copilot-app/​5-publish.md Move Japanese warning before publication prompt.
docs/​first-steps/​copilot-cli/​2-project-instructions.md Clarify optional /init instructions in English.
docs/​first-steps/​copilot-app/​5-publish.md Move English warning before publication prompt.
docs/​first-steps/​copilot-app/​12-deploy-pages.md Separate English deployment preparation, review, authorization, and verification.
docs/​es-es/​real-world-development/​app/​1-install-copilot-app.md Correct Spanish cloud and Enterprise Server sign-in guidance.
docs/​es-es/​first-steps/​copilot-cli/​2-project-instructions.md Clarify optional /init instructions in Spanish.
docs/​es-es/​first-steps/​copilot-app/​5-publish.md Move Spanish warning before publication prompt.

Review effort: Balanced

@GeekTrainer
GeekTrainer merged commit ecfee62 into main Nov 13, 2026
8 checks passed
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