CS3704 Canvas Project — Documentation Portal

Welcome to the team documentation portal. This site is built with MkDocs and deployed automatically on every push to main.

Project Overview

CS3704 Canvas Project is a Canvas LMS productivity client with a mature Textual TUI, a live browser extension codebase, and a maintained documentation portal.

Current status: main is the only long-term branch, the docs site deploys from main, and the browser extension now has a shared client/runtime architecture instead of ad hoc popup-to-background wiring.

Quick Links

Resource	Link
🎓 Try the live agent	agent-demo
🤗 Model card	canvas-calendar-agent-v7-dpo
🤗 Dataset	canvas-calendar-preferences-v7
🤗 Inference Space	canvas-calendar-agent-demo
🤗 Collection (v3.0 9-method matrix)	Canvas Calendar Agent v3.0
🤗 GGUF for Ollama	canvas-calendar-agent-v7-dpo-gguf
🚀 Live Demo & ML Assets page	live-demo
GitHub Repo	kleinpanic/CS3704-Canvas-Project
Latest Release	v3.0.0
Open Issues	Issue Tracker
Open PRs	Pull Requests
Project Board	Sprint Board
Docs Site	GitHub Pages

Architecture Documentation

• Architecture Overview — current application structure and platform layout
• Browser Extension — shared client, runtime contract, popup/background architecture
• Team Workflow — branch strategy, PR process, CI gates, and contribution policy
• Project Roadmap — current status, active architecture work, and next milestones

Current Product Surface

Implemented Today

• Textual TUI dashboard and course views
• grades and assignment workflows
• offline-first cache layers
• browser extension popup and background worker
• extension-side shared Canvas client layer
• GitHub Pages documentation site
• CI/CD and protected-branch governance

Recently Merged

• #81 settings UI — full config persistence, keybindings, theme/layout controls
• #83 SDK agent tools — 18-tool agent registry and calendar adapter
• #70 extension multi-view — courses tab and drill-down navigation
• #86 settings follow-up — 10 fixes applied across 47 tests from cross-AI review

Important Repo Policy

• main is the canonical long-term branch
• feature branches are temporary and PR-scoped
• merged PR branches should be deleted
• direct AI automation is not part of the merge path

Deployment

Environment	URL	Trigger
Docs Site	kleinpanic.github.io/CS3704-Canvas-Project	Every push to main
Release snapshots	GitHub Releases	Main/release workflow

The docs site is built with MkDocs Material and deployed via GitHub Actions.

CI/CD Snapshot

feature/docs/fix branch
  -> PR to main
  -> Branch Name Policy
  -> Test
  -> Python Compat matrix
  -> maintainer review
  -> squash merge
  -> branch auto-deleted

main
  -> Pages deploy
  -> release/security follow-up workflows

Team

Role	Member	Responsibility
Owner	Klein Panic	Architecture, CI/CD, releases
Maintainer	Williammm23	Feature development
Maintainer	pjie22	Documentation and implementation review
Maintainer	802797liu	Tests and filtering work

See CONTRIBUTORS.md and MAINTAINERS.md for more detail.