Add workshop scaffold script for new contributors and interns#634
Open
beagandica wants to merge 5 commits intoNuevoFoundation:masterfrom
Open
Add workshop scaffold script for new contributors and interns#634beagandica wants to merge 5 commits intoNuevoFoundation:masterfrom
beagandica wants to merge 5 commits intoNuevoFoundation:masterfrom
Conversation
beagandica
pushed a commit
to beagandica/workshops
that referenced
this pull request
Apr 27, 2026
Merge comprehensive workshop creation guidance from WORKSHOP-STANDARDS.md (PR NuevoFoundation#597) into the /guidelines/ pages so they are the one-stop shop for contributors. PR NuevoFoundation#597 can now be closed. new-workshops.md rewritten from 3-line stub to comprehensive guide: - Workshop philosophy (story-driven, personalizable, self-paced, progressive) - Gold standard examples (web-basics, python-turtle, earsketch) - Scaffold script workflow (integrated from PR NuevoFoundation#634) - Comprehensive quality checklist (36 items across 6 categories) - PR review checklist (10 items for reviewers) - Cross-links to all specialist guideline pages Also updated: - images-and-gifs.md: standardized on media/ convention (scaffold default), added backward-compat note for older workshops using img/, fixed shortcode delimiter consistency - translation-volunteer.md: added Spanish tu-conjugation note - _index.md: aligned all link texts with target page titles (sentence case) 10-model QA + 3 clean convergence passes. Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Generates a complete workshop directory with template files: - _index.md with Hugo frontmatter and TOC shortcode - Numbered activity files with steps/challenge structure - Answer key (optional) with per-activity solution blocks - Empty media/ directory Includes validation (kebab-case names, language dirs), dry-run mode, and verbose output. Stdlib-only, no dependencies. Co-authored-by: Copilot <[email protected]>
Per NF-QA-STANDARD.md TOC behavior section: workshops should use alwaysopen: false to start with collapsed TOC sections. Co-authored-by: Copilot <[email protected]>
Rewrite new-workshops.md from 3-line stub into comprehensive guide that makes the scaffold script (tools/new-workshop.py) the mandatory first step for creating new workshops. Add scaffold callout to getting-started.md. Changes: - new-workshops.md: full rewrite with scaffold as Step 1, options table, dry-run tip, content editing guide, local preview, PR workflow, and 8-item pre-PR checklist (first item: used scaffold script) - getting-started.md: add Creating a new workshop? section at bottom with scaffold command and link to new-workshops page 10-model QA + 3 clean convergence passes applied. Fixes from QA: - Python 3.7+ prerequisite and python3 fallback note - Distinct image paths for _index.md vs activity pages - Kebab-case validation details (must start with letter) - answer-key conditional language (if generated) - Language folder note in git add step - Mandatory scaffold framing (not optional) Co-authored-by: Copilot <[email protected]>
66fb763 to
bb0201e
Compare
beagandica
pushed a commit
to beagandica/workshops
that referenced
this pull request
Apr 29, 2026
Merge comprehensive workshop creation guidance from WORKSHOP-STANDARDS.md (PR NuevoFoundation#597) into the /guidelines/ pages so they are the one-stop shop for contributors. PR NuevoFoundation#597 can now be closed. new-workshops.md rewritten from 3-line stub to comprehensive guide: - Workshop philosophy (story-driven, personalizable, self-paced, progressive) - Gold standard examples (web-basics, python-turtle, earsketch) - Scaffold script workflow (integrated from PR NuevoFoundation#634) - Comprehensive quality checklist (36 items across 6 categories) - PR review checklist (10 items for reviewers) - Cross-links to all specialist guideline pages Also updated: - images-and-gifs.md: standardized on media/ convention (scaffold default), added backward-compat note for older workshops using img/, fixed shortcode delimiter consistency - translation-volunteer.md: added Spanish tu-conjugation note - _index.md: aligned all link texts with target page titles (sentence case) 10-model QA + 3 clean convergence passes. Co-authored-by: Copilot <[email protected]>
ozhang22
pushed a commit
that referenced
this pull request
May 6, 2026
…13) (#636) * Add 5 missing guidelines pages (Closes #7, #10, #11, #12, #13) New content pages for the contributor guidelines section: - Translation volunteer guide (Closes #7) - Images and GIFs (Closes #10) - Navigation (Closes #11) - Code and interactivity (Closes #12) - Tags and metadata (Closes #13) Updated _index.md to link all new pages and add a Translators section. These issues have been open since July 2019. The content is based on patterns established across 42 workshops and our NF QA standard. Co-authored-by: Copilot <[email protected]> * Fix QA findings: .NET Fiddle naming, CodePen pattern, Replit note, cross-refs - Rename 'DotNetFiddle' to '.NET Fiddle' in prose (matching repo convention) - Replace CodePen iframe embed with actual repo pattern (button link) - Add note about replit.com vs old repl.it domain - Note that raw HTML works without rawhtml shortcode (unsafe=true enabled) - Add see-also cross-references to related guideline pages Co-authored-by: Copilot <[email protected]> * Fix QA pass 2 findings: icon table, details HTML, figure claim, Replit, notices - H1: Remove broken icon shortcodes from table (theme incompatible), use text-only - M1: Fix <details close> to <details> (valid HTML for collapsed state) - M2: Remove 'preferred approach' claim for figure shortcode - M3: Remove deprecated ?lite=true from Replit embed example - M4: Use generic issue link (template PR not yet merged) - M5: Fix notice shortcode delimiter from < > to % % Co-authored-by: Copilot <[email protected]> * Fold PR #597 workshop standards into guidelines pages Merge comprehensive workshop creation guidance from WORKSHOP-STANDARDS.md (PR #597) into the /guidelines/ pages so they are the one-stop shop for contributors. PR #597 can now be closed. new-workshops.md rewritten from 3-line stub to comprehensive guide: - Workshop philosophy (story-driven, personalizable, self-paced, progressive) - Gold standard examples (web-basics, python-turtle, earsketch) - Scaffold script workflow (integrated from PR #634) - Comprehensive quality checklist (36 items across 6 categories) - PR review checklist (10 items for reviewers) - Cross-links to all specialist guideline pages Also updated: - images-and-gifs.md: standardized on media/ convention (scaffold default), added backward-compat note for older workshops using img/, fixed shortcode delimiter consistency - translation-volunteer.md: added Spanish tu-conjugation note - _index.md: aligned all link texts with target page titles (sentence case) 10-model QA + 3 clean convergence passes. Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Beatris Mendez Gandica <[email protected]> Co-authored-by: Copilot <[email protected]>
Documents the brand palette (emphasis #36374d, accents cyan/red/coral/ yellow/blush, plus neutrals) so contributors building visual workshops (CSS demos, mini-games, diagrams) can stay on-brand without guessing. References js-snack-picker as a real-world example. Co-authored-by: Copilot <[email protected]>
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
Workshop scaffold script for creating new workshop directories with all required template files. Designed for summer interns and new contributors.
Usage
What it generates
Features
--dry-runpreviews without writing, checks for existing directoriesfrom __future__ import annotationsfor 3.7+ compat)QA
downloadfield removed, dynamic answer-key weight, .gitkeep for empty dirs, activity cap, input validation