Learn

Check it out here

A site for more optimized learning. A course gets imported and displayed in nice and structured fashion. This functions as a study tool for both long and short term learning with review, notes, and quick lookup functionality.

A course is the specific thing you want to learn/study (like a class, or certain subject). You can ask an AI to easily design the course. The course is made by formatting the needed course data. The code and visual experience is handled by this site.

Using

Getting started

1. Make a course for the content you want to learn.
2. After having a course made, you'll end up with either a folder for the course or a .json. Click Add a Course within the site, and select the folder with the course name you want, and it'll add it to the site.
3. Click on the course to enter. There'll be a sidebar with all the course sections, and the different features:
   • Index provides and overview of the course concepts and categories.
   • Mixed Practice is for practice questions. Questions explains the practice types.
   • Review pulls questions from, concepts you've drilled, and question types you were confident in but missed.
   • Dependency Map demonstrates how sections connect to each other.
   • Explore
     • The Discover section allow you to quickly find needed information.
     • The Saved section shows all the blocks you saved with notes.
4. Each section is split into subsections which is further split into blocks.
   • Each block represents some form of information.
   • Some blocks are hidden depending on the mode, but they can always be opened (there will always be a sign of it being there, so you're not missing anything).
   • You can click/drag down on the horizontal tabs on the bottom of the block to save a note (notes will be added to the Saved section of Explore).
   • Blank notes act as simple bookmarks that still appear in Saved.
5. The top right provides Study, Review, and Names modes. These correspond to the depth of information shown.
   • Study is like reading through a textbook. It shows the most, with the only things hidden being the In Depth blocks.
   • Review is like going through ones notes. Each block may have a description which is used instead of the full content. Certain blocks are also not hidden. This view is tailored by the course creator.
   • Names hides everything, showing the bare minimum.

Questions

Drills: These are question variations. They are meant for repeat practice to ensure something sticks. The questions are provided in a given format with distinct answer choices.

Question Types: These are the unique questions you may encounter in a test. The thought behind these, is that a given test is usually limited in what types of questions can appear. They help ensure understanding what was taught, and appear after each sub-section.

Writing a course

To start working on a course:

#               id       name
npm run new -- ma26600 "Ordinary Differential Equations"

This will add a course to courses/ma26600.

You can then start working on the course within that folder. The changes can be validated with:

npm run validate -- ma26600
npm run audit -- ma26600

Finally import your course to the site and enjoy.

node plugin/scripts/pack.mjs <id> creates a .course.json you can import into a site (not needed though, you can just import the course folder).

Write a course with AI

Add the course content under courses/<your-course>/sources (so the model know what to work off). If you add your course textbook, it'll be able to reference specific textbook portions, and provide a greater guarantee of coverage.

This document details how to write out a course. This document is for AI's prose/writing.

The AI can use the create-course skill, which runs these:

node tools/author.mjs begin ma26600 --source ~/code/some-repo  # sources + the rules for the course's shape
node tools/author.mjs write ma26600 --lean  # the writing rules (--lean: cheaper)
node tools/author.mjs done ma26600 s1-6 /abs/source.md  # records a subsection, and names the next
node tools/author.mjs finish ma26600  # materials, validation, coverage
npm run coverage -- ma26600  # does a comparison to see if the course is covering everything

Claude:

# to add as a plugin
/plugin marketplace add Jightning/learn
/plugin install create-course@learn

# adding as a plugin without installing
claude --plugin-dir plugin

Other Agents:

Run the following command

node plugin/install.mjs ~/my-courses   # for other agents, adds the AGENTS.md which links back to this repo

Development

Developing:

npm install
npm run dev

Building:

npm run build  # for dist/
npm run deploy  # builds, publishes to Cloudflare Pages, and keeps 2 newest deployments
npm run check  # engine checks against demo and _template; user courses are not read

Testing:

npm run test  # full testing

npm run test:unit
npm run test:integration
npm run test:browser

Todo

• Different questions answer functionalities (numeric allows for validated number input within a certain tolerance, multiple choice with any amount of answer choices, multiple select, etc.)
• Better general quiz system. Currently it feels to confusing with very little customizability.
• Big delay in mobile when selecting a section (sometimes requires clicking twice). Same applies to sub-sections.
• Render error in ECE27000 4.3
• Links to figures go to the top of the section rather than the exact figure.
• Ability to save entire subsections from within the sidebar
• Allow for bolding, italicization, highlighting, etc. (inline customization of block text)