Adding Study Materials

Adding Study Materials 📤

Want to share your notes with everyone?

Here's how to add materials to Plexi's shared library!

---

What is the Library? 📚

Plexi stores all materials in a "Digital Dropbox" - a shared folder (repository) on GitHub.

Why GitHub?

• Free storage for everyone
• Version control (tracks changes)
• Easy for anyone to contribute

All uploaded materials get:

1. Uploaded to GitHub Releases (downloadable files)
2. Added to the manifest (the materials list)
3. Processed into the AI index (so the AI can search them!)

---

What Can You Upload? 📄

✅ Accepted:

• PDF files (notes, slides, papers)
• PowerPoints (.ppt, .pptx)
• Word files (.doc, .docx)
• Question papers
• Syllabuses
• Assignments

❌ Not Accepted:

• Copyrighted paid materials
• Anything not related to your course

---

Step-by-Step: Upload Materials 🚀

Step 1: Go to the Upload Form

Visit: https://github.com/KunalGupta25/plexi-materials/issues/new?template=upload-material.yml

(Or go to plexi-materials repo → Issues → New Issue → "Upload Study Material")

Step 2: Fill the Form

You'll answer:

Field	What to Write
Semester	Select: "Semester 1", "Semester 2", etc.
Subject	Select your subject from the list
Material Type	Notes, PDFs, PPTs, Question Papers, etc.
File	Drag & drop your file here
Additional Notes	(Optional) Chapter number, topic, etc.

Step 3: Submit

Click "Submit new issue."

---

What Happens Next? 🔄

Here's the magic process:

Your Issue Submitted
       ↓
Maintainer Reviews (checks it's appropriate)
       ↓
"approved" Label Added
       ↓
Automation Runs:
  1. process_upload.py → Uploads file to GitHub Release
  2. Updates manifest.json (adds to materials list)
  3. build_index.py → 
     - Downloads file
     - Extracts text (with OCR for scanned pages)
     - Converts PowerPoints/Word to PDF
     - Builds AI search index
  4. Commits changes to repo
       ↓
File Available in Plexi! 🎉

Time: This usually takes 5-15 minutes after the label is added.

---

Understanding the Index 🧠

When you upload a file, Plexi:

1. Extracts text - Reads all the text from your PDF/slides
2. Runs OCR - For scanned images, reads the text from pictures
3. Labels it - Tags with semester + subject + type
4. Adds to search index - Now the AI can find answers in your material!

This is called RAG (Retrieval-Augmented Generation).

---

Tips 📎

📏 File naming - Use clear names like "Unit-1-Notes.pdf"

📑 One file per topic - Better to upload multiple small files than one big one

📝 Check existing - Search the Hub first to see what's already there

---

Need Help? 🛟

Questions? Issues?

• Check existing issues: https://github.com/KunalGupta25/plexi-materials/issues
• Open new issue: https://github.com/KunalGupta25/plexi-materials/issues/new

---

Thanks for contributing! Every upload helps fellow students 📚