User Guide

How to use SmartKnowledge — an AI-powered knowledge platform where instructors publish course material and students get a RAG-based tutor that answers from it, with sources.

On this pageGetting startedFor studentsFor instructorsFor adminsTips & troubleshooting

Getting started

  1. 1Go to Sign up and create an account with your email, a password, and your role (Student or Instructor).
  2. 2Check your inbox for a verification email (check Spam/Junk too — first-time delivery sometimes lands there) and click the link.
  3. 3Log in. You'll land on your Dashboard, which shows your recent subjects and chat sessions.
  4. 4Open Settings any time to update your name, change your password, or request an email change.

Admin accounts aren't created through sign-up — an existing admin has to promote a regular account. If you need admin access, ask whoever manages your deployment.

For students

Subjects are the unit everything is organized around — a subject holds its own documents, chat history, exercises, and Course Learning Outcomes (CLOs).

  • Subjects — browse or search all subjects from the navbar. Open one to see its Documents, Chat, and CLO tabs.
  • Chat — ask questions about a subject's material in plain language. Answers cite the specific document (and page, or image) they came from, so you can verify anything the tutor tells you. Your chat history is saved per subject under Chat in the navbar.
  • Exercises — instructors publish quizzes per subject, some with AI-generated questions. Multiple-choice questions are graded instantly; open-ended ones are graded by the instructor. See every attempt you've made across all subjects under My Grades.
  • CLO progress — the CLO tab on a subject page shows how your quiz results add up against that subject's learning outcomes.
  • Dashboard — your home base: recent subjects, recent chats, and an activity heatmap of your own uploads/chats/attempts over the last year.

For instructors

  1. 1Create a subject from the Subjects page, and define its CLOs (Course Learning Outcomes) — these are what student performance gets measured against later.
  2. 2Upload documents (PDF, PPTX, DOCX, or images) into the subject. Each one shows a status badge: Queued → Indexing → Indexed. This can take a little while for large or image-heavy files — the tutor can only answer from a document once it reaches Indexed. If a document shows Indexing failed, hover the badge for the reason and use Retry.
  3. 3Once documents are indexed, students in that subject can immediately start asking the AI tutor questions about them — including questions about diagrams and figures, not just text.
  4. 4Create exercises for the subject: either author questions yourself (multiple-choice or open-ended), or use Generate with AI to draft questions from the subject's own material, then edit before publishing.
  5. 5Grade open-ended answers as students submit them; multiple-choice is scored automatically.
  6. 6Check the CLO tab to see attainment across the whole subject, not just one student.

For admins

  • Admin panel — manage every account on the platform: promote a student/instructor to admin, deactivate accounts, and review signups.
  • Overview — platform-wide numbers per subject: documents, chat sessions and messages, how often the tutor had no source to cite, and thumbs up/down feedback on answers.

Tips & troubleshooting

  • No verification email? Check spam first. If it's really missing, use the resend option on the verify-email page — this is rate-limited, so repeated hammering just locks it out for longer.
  • The tutor says it has no source for my question. It only answers from documents that finished indexing in that specific subject — check the Documents tab for anything still Queued/Indexing/failed, or the question may genuinely be outside the uploaded material.
  • A document has been stuck on Indexing for a long time. Large files with many images take longer. If it eventually shows Indexing failed, use Retry — if that fails again, re-uploading is usually the fix.
  • Can I change my role myself? No — role changes are an admin-only action, by design.
  • Where do I see my grades across every subject at once? My Grades in the navbar, not the individual subject's CLO tab.