feat: add facilitator documentation, general themes, module notes, and event template#5
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
Conversation
…d event template Move facilitator-facing content from workshop-metadata into operator: - docs/facilitator-guide.md: day-of logistics, pacing, format variations - docs/quality-checklist.md: content authoring standards - docs/repo-naming-convention.md: GH org naming rules - docs/runtime-resources.md: hosted app provisioning guide - docs/workshop-design-guide.md: creating modules, workshops, events - docs/general-themes/: positioning narratives (7 files) - docs/module-facilitator-notes/: per-module facilitator companions (11 files) - templates/event-readme.md: starting template for new events Updated README with facilitator documentation index and cross-reference to workshop-metadata for attendee-facing lab content.
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
3 tasks
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
1 participant
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
Adds all facilitator-facing documentation to the operator repo, establishing it as the single source for workshop hosts. Content was migrated from the workshop-metadata repo as part of an audience separation: workshop-metadata is now attendee-only, operator is for facilitators.
New files added:
docs/facilitator-guide.md— day-of logistics, pacing, common issuesdocs/workshop-design-guide.md— how to create modules, workshops, and events; time budgets; audience recommendations; format variationsdocs/quality-checklist.md— quality standards for workshop content authoringdocs/repo-naming-convention.md— naming rules for the GH orgdocs/runtime-resources.md— provisioning hosted apps for events + local run instructionsdocs/general-themes/— 7 positioning narrative docs (when to use Devin, architecture strengths, design patterns, platform capabilities, collaboration model, value narratives)docs/module-facilitator-notes/data-engineering/— 9 module-specific facilitator companionsdocs/module-facilitator-notes/security/— 2 module-specific facilitator companionstemplates/event-readme.md— starting template for new event READMEsREADME.md updated with new intro (facilitator audience), directory structure, and "Facilitator Documentation" index table linking all new docs.
Companion PR: workshop-metadata repo (audience separation — removes facilitator content and rewrites for attendees).
Review & Testing Checklist for Human
Low risk — all Markdown content, no code changes. 2 items to verify:
docs/facilitator-guide.mdvs the oldshared/facilitator-guide.md)docs/workshop-design-guide.mdresolve correctly (especially cross-references to other docs/ files and the workshop-metadata repo link)Notes
general-themes/is intentionally present in BOTH repos: operator has it for facilitator positioning, workshop-metadata retains it because 100+ module files link to it as educational context for attendees.workshop-design-guide.mdwas newly authored (not moved) — it consolidates facilitator workflow instructions that were previously scattered across workshop-metadata's workshops/README.md and events/README.md.Link to Devin session: https://partner-workshops.devinenterprise.com/sessions/c5c8b4f84efd459eb20d9c1f1ae495ff
Requested by: @bsmitches