Course profile
- Langage dominant
- TypeScript
- Étoiles
- 6
- Forks
- 3
- Merge moyen
- 3 j 17 h
- PR mergées (30 j)
- 15
Description
## Description
Implementation of the [E01](https://github.com/akai-org/put-wiki/blob/main/docs/product/requirements.md#e01-wy%C5%9Bwietlanie-informacji-o-przedmiotach-i-prowadz%C4%85cych) functional requirement from docs. The main goal is to provide profile for each course with up-to-date, reliable and structured information that is valuable from student perspective and is not just a copy/data aggregator using many official sources.
## Scope
### What it includes:
- Separate profile page for each course
- Defining course uniqueness not by its name but with the context it exists, e.g. basics of electronics on computer science (S1Inf1>ELEK) is not the same course as on automatics and robotics (S1AiR2>PE). This is the same for study modes and degrees, e.g. mathematical analysis on computer science full time (S1Inf1>ANAM) is not the same course as on computer science part time (N1Inf1>ANAM).
- Profile contains featured groups - course types, e.g. discrete math course has types lecture and practical classes.
- Information is mostly present as a structured easy to read and appealing visual content, e.g. scales, % rates, badges/tags, timelines, etc.
- Part of the profile content can be managed through headless CMS by administrators (e.g. some text paragraphs, dynamic fields).
- Data updates are semi-automated and don't need constant moderators involvement.
- We fetch data from several official resources as well as provide some community driven sections in profiles (crowdsourcing, e.g. course star rating).
- Linking to PUT websites. (syllabus etc.)
- Each specific course has a section for notes and materials useful for students (appropiately structured and handled by administrators). It only links to them.
### Out of scope:
- Adding official/legal information directly as this is the responsibility of the PUT administration. We should link to official PUT website instead.
- Any kind of chats, communication between users in real time on course profile. We don't want to try to replace discord, messenger, etc.
- Hosting files. Besides from high cost it can also lead to legal issues (copyright, etc)
- Copying syllabus for each course (or even just section in profile only with the text copied from it). There is no need to adding sylabus as it is available at the official website.
## Notes
We have to deal with how to make the course reusable and generic so that it can be used with various fields of study, modes and degrees. There should be separate technical discussion on that.
Categories of information:
1. community-driven (e.g. difficulty or time consuming rates, tags)
2. data-driven (pass rates, grades distribution, graph of connections with other courses)
3. student opinions (from different module)
4. basic official info (sylabus link, lecturers per course form, faculty, degree, mode, term)
See [this document](https://docs.google.com/document/d/1BnwjPViFJ4Fk8Kd9IP-uamBjXopJWgkhCl06BP4ucks/edit?tab=t.0) from meetings for more details.
Guide de contribution
Ouvrir le guide de contribution
Évaluation
Cette issue n'a pas encore été évaluée.