docs: simplify workshop authoring and verification guidance - #169
Merged
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This was referenced Sep 14, 2026
GeekTrainer
added this pull request to stack #173
September 14, 2026 21:02
This was referenced Sep 14, 2026
GeekTrainer
removed this pull request from stack #173
September 14, 2026 21:30
GeekTrainer
added this pull request to stack #175
September 14, 2026 21:31
9 tasks
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The unresolved workflow inconsistency and duplicated verification procedures should be addressed before approval.
Get a fresh assessment by requesting another Copilot review.
Review tier: Lite
Findings: 1
Open (1)
What changed in this PR
This PR centralizes workshop authoring and verification guidance and adds Bash/PowerShell wrappers around existing site checks.
Changes:
- Replaces fixed page-count guidance with source/configuration-based inspection.
- Adds cross-platform verification wrappers.
- Updates contributor documentation, skills, CI guidance, templates, and Copilot instructions.
| File | Summary |
|---|---|
README.md |
Points contributors to centralized verification guidance. |
CONTRIBUTING.md |
Documents CI checks and verification workflow. |
AUTHORING.md |
Adds lesson guidance and streamlined verification instructions. Nit (1 vote): Link the existing-lesson recipe to the canonical skill instead of repeating npm run dev. |
.github/workflows/pages.yml |
Updates CI description. |
.github/skills/validate-site-playwright/SKILL.md |
Aligns browser validation with static verification. Nit (2 votes): Clarify or replace the separate build-only prerequisite. |
.github/skills/README.md |
Updates the skill index. |
.github/skills/make-repo-contribution/SKILL.md |
References centralized verification guidance. |
.github/skills/check-content-alignment/SKILL.md |
Simplifies content-alignment review. Moderate (1 vote): Align the related workflow’s exclusion rules and historical passage list with this procedure. |
.github/skills/build-and-verify-docs/SKILL.md |
Defines wrapper-based verification and manual review responsibilities. |
.github/skills/build-and-verify-docs/scripts/verify.sh |
Adds the Bash verification wrapper. |
.github/skills/build-and-verify-docs/scripts/verify.ps1 |
Adds the PowerShell verification wrapper. |
.github/pull_request_template.md |
Updates the verification checklist. |
.github/instructions/astro.instructions.md |
Removes fixed page-count guidance. |
.github/copilot-instructions.md |
Updates repository verification guidance. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| # Validate the built site with Playwright | ||
|
|
||
| `build-and-verify-docs` checks the site *statically* — it builds, confirms the page-count invariant, and link-checks the HTML with lychee. It never opens a page in a browser, so it cannot see runtime failures: console/hydration errors, images that 404 at load time, or rendered Markdown that looks wrong. | ||
| `build-and-verify-docs` checks the site *statically* — it type-checks, builds, inspects affected output against its source, and link-checks the HTML with lychee. Browser checks complement that evidence by finding runtime failures: console/hydration errors, images that fail to load, or visual rendering problems. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
Layer 1/4 of the replacement stack for source #167, based on
main: centralizes authoring guidance and adds small Bash and PowerShell wrappers that call existing verification commands. Following the YAGNI/reuse review, the custom verification engine, fixture framework, site capture hooks, and direct HTML-parser dependency declaration have been removed; source-page, semantic, translation, and visual inspection remain AI responsibilities.Type of change
website/Astro + Starlight wrapper).github/copilot-instructions.md, instructions, agents, skills)Verification
/tmp:npm run check:all, cleanwebsite/dist, andnpm run build. Zero type-check errors; four existing Astro deprecation hints remain. Bash syntax validation passed. Disposable probes exercised paths with spaces, another working directory, native failure exits 7/9/23, temporary-root cleanup, missing configuration, and refusal to remove a linked output directory.5d881debyte-for-byte. The wrappers do not automate source-to-HTML or translation comparisons; the skill explicitly requires AI inspection of affected pages for content changes.Notes for reviewers
The current implementation is only
scripts/verify.sh(32 lines) andscripts/verify.ps1(53 lines), plus concise skill guidance. Both wrappers locate the repository from their script location, reuse package scripts, clean onlywebsite/distwith a link/file guard, and call offline Lychee. PowerShell usesnpm.cmdon Windows and explicitly preserves native command exit codes. PowerShell was unavailable, so its wrapper is unexecuted and not parser-validated; no installation or execution-policy bypass was performed.The latest simplification changes 12 paths, adding 112 lines and removing 686. All four custom engine/test
.mjsfiles are deleted. The Astro configuration, content loader,package.json, andpackage-lock.jsonare restored exactly to their pre-engine contents; the original transitive parser dependency is preserved. There is no new dependency, capture integration, content-comparison engine, or committed fixture framework. Validation reused already-installed packages with local caches; temporary links and probes were removed.Like the unchanged Pages workflow, the wrappers map the current
/copilot-workshops/base path to built output; the skill documents updating that mapping alongside the workflow if the site base changes. CI behavior remains unchanged: existing type checks, build, and pinned offline-link validation. The earlier Pages workflow change is comment-only.Source-page inspection, semantic accuracy, teaching flow, translation quality, intentional harness differences, and visual/browser behavior remain AI responsibilities. Successful command execution does not prove exact rendered prose or correct translations. Existing plain-div admonition styling is unchanged. There is no current claim of a bundled 17-test verification framework; that framework was removed with the engine.
Curriculum files under
docs/, deferred lesson-name examples in.github/instructions/markdown.instructions.md, and existing curriculum descriptions in shared authoring files remain untouched by this tooling follow-up. The draft stack order remains #169 → #174 (App) → #170 (VS Code/Cloud) → #171 (CLI). Source #167 is preserved unchanged; this update does not change stack membership, PR bases, draft state, or auto-merge settings.