Learning Operations Skill
Quick Start
This skill helps you manage the lifecycle of educational content in learning/.
Common Tasks
- •
Create a new module:
bashpython .github/skills/learning-ops/scripts/init_learning_structure.py --path ./learning --add-module 05-new-topic --title "New Topic"
- •
Validate structure and links:
bashpython .github/skills/learning-ops/scripts/init_learning_structure.py --path ./learning --validate
- •
Sync check (conceptual): Refer to syncing.md for verifying code examples match documentation.
When to Use
- •Structure: Adding new numbered modules, ensuring READMEs and exercises exist.
- •Maintenance: Auditing content for freshness or deprecation.
- •Syncing: Linking code examples in
packages/to explanations inlearning/. - •References: Creating cross-links between modules or from code to docs.
Reference Guides
- •Structure Layout: The canonical directory tree rules.
- •Material Maintenance: How to audit and update content.
- •Code Syncing: Keeping docs and code in harmony.
- •Cross-Referencing: Linking strategies.
Included Resources
Scripts
- •
scripts/init_learning_structure.py: Idempotent structure generator and validator.
Assets
- •
assets/template_readme.md: Standard template for new modules.
Workflow: Adding a New Educational Concept
- •Identify the Code: Find or create the example code in
packages/*/src/examples/. - •Create Module: Use the script to scaffold the
learning/XX-topic/folder. - •Write Content: Use the templates. Reference the code using
[File Link](../../packages/...). - •Cross-Ref: Update previous modules to point to the new advanced topic if relevant.
- •Validate: Run the validation script to check file presence.