Skip to content

Conversation

@ibihim
Copy link

@ibihim ibihim commented Oct 30, 2025

Summary

Add new learning plugin with two commands for helping engineers understand code and concepts through structured educational approaches.

Commands

/learning:explain <file|package|concept>

Provides deep, first-principles explanations using WHAT/WHY/HOW structure:

  • WHAT: High-level overview and mental models
  • WHY: Problem being solved and design decisions
  • HOW: Implementation details and mechanisms

Works with:

  • Code files (e.g., pkg/reconciler/controller.go)
  • Packages (e.g., pkg/cache)
  • Technical concepts (e.g., eventual consistency)

/learning:build-from-scratch <topic or technology>

Creates Liz Rice-style "Build Your Own X" walkthroughs:

  • Starts with simplest working example
  • Builds incrementally (one concept per step)
  • Provides runnable code at every step
  • Shows how complexity emerges from simple fundamentals
  • Connects to real-world production systems

Output in .work/learning-build-from-scratch/{topic}/

Changes

  • Added plugins/learning/ directory with plugin structure
  • Created plugin.json metadata
  • Created two command definitions following man page format
  • Created comprehensive README with usage examples
  • Registered plugin in marketplace.json
  • Auto-generated documentation (PLUGINS.md, docs/data.json)

Testing

  • ✓ Validated with make lint (all checks passed)
  • ✓ Plugin follows all repository conventions
  • ✓ Command definitions follow man page format
  • ✓ Proper frontmatter and required sections

…atch commands

Add new plugin for educational purposes with two commands:
- explain: First principles explanations using WHAT/WHY/HOW structure
- build-from-scratch: Progressive walkthroughs building systems from fundamentals

The plugin helps engineers understand code and concepts through structured
learning approaches.
@openshift-ci openshift-ci bot requested review from bryan-cox and dgoodwin October 30, 2025 17:11
@openshift-ci
Copy link

openshift-ci bot commented Oct 30, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ibihim
Once this PR has been reviewed and has the lgtm label, please assign stbenjam for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 30, 2025
@openshift-ci
Copy link

openshift-ci bot commented Oct 30, 2025

Hi @ibihim. Thanks for your PR.

I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@theobarberbany
Copy link
Contributor

/ok-to-test

@openshift-ci openshift-ci bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 30, 2025
@@ -0,0 +1,174 @@
---
description: Create a Liz Rice-style walkthrough building a concept from first principles with working code
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we are not wanting to get AI's to generate any content as if they were a specific human. Especially without permission, but this is probably a general rule we should establish in the repo regardless. Instead, I'd suggest frame it as what qualities you like about how she presents the material. It's also better for the AI to understand

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Indicates a non-member PR verified by an org member that is safe to test.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants