This commit is contained in:
Daniel Hládek 2026-09-24 20:10:45 +02:00
parent 72c29f1c1b
commit fd5d958a3e

71
AGENTS.md Normal file
View File

@ -0,0 +1,71 @@
# Repository Description for Agents
This repository hosts the GRAV CMS-based wiki for the Department of Electronics and Multimedia Telecommunications (KEMT) at Technical University in Košice (TUKE). It is a collaborative academic platform where students and faculty share final theses, project notes, and NLP (Natural Language Processing) research materials.
## System Overview
- **CMS**: [GRAV](https://getgrav.org/) — a flat-file CMS that stores content as Markdown files.
- **Content format**: Each page is a directory containing a `README.md` file with YAML frontmatter (title, taxonomy, author, publication status).
- **Version control**: All changes are tracked via Git on the institution's GitLab instance (`git.kemt.fei.tuke.sk`).
## Directory Structure
```
pages/ # Root of GRAV CMS content
├── home/ # Homepage (index page)
├── 02.browse/ # Browse/search landing page
├── 04.categories/ # Category listing pages
├── 05.tags/ # Tag listing pages
├── taxonomy/ # Taxonomy index pages
├── authors/ # Author profile pages
├── interns/ # Intern profiles (organized by student name)
├── students/ # Student profiles (organized by year of enrollment)
│ └── <start_year>/
│ └── <student_name>/README.md
└── topics/ # Project notes and reference materials
```
## Student Profiles (`pages/students/`)
Each student has an individual profile directory named `<first_name>_<last_name>` organized under a year subdirectory (`2016`–`2024`). Profiles track academic work including:
- **Study year** (`rok začiatku štúdia`)
- **Thesis type**: bakalársky projekt (bp), magistrský projekt (mp), bakalárska práca (bp), diplomová práca (dp), veterinárna práca (vp)
- **Thesis topic and goals** (`Téma`, `Ciele na semester`)
- **Thesis assignment** (`Zadanie` / `Návrh na zadanie`)
- **Meeting logs** (`Stretnutie`) — dated records with tasks assigned, progress notes, and current status (`Stav`)
- **Tasks** (`Úlohy`) — specific deliverables and assignments
- **Project outputs** — code repositories, models, demo applications
- **Tags** — project domains (e.g., `nlp`, `rag`, `ner`, `chatbot`, `multimodal`, `dataset`, `evaluation`)
Example path: `pages/students/2022/jakub_schwarc/README.md`
## Project Notes (`pages/topics/`)
Each topic is a directory (or file) under `pages/topics/` containing:
- **Project descriptions** — goals, scope, applications
- **Task lists** — planned and completed work items
- **Research references** — papers, datasets, tools, frameworks
- **People** — team members involved
- **Notes** — meeting notes, experimental results, troubleshooting
Topics cover NLP research areas including BERT training, chatbot development, hate speech detection, named entity recognition, machine translation, sequence-to-sequence models, legal text processing, morphological analysis, and Slovak question answering.
## Grav-specific Conventions
- **Numeric prefixes** (`02.`, `04.`, `05.`) control page ordering in the GRAV navigation tree.
- **YAML frontmatter** uses `taxonomy` for categories (`[dp2027]`, `[bp2025]`, `[project]`, `[info]`) and tags (`[nlp]`, `[rag]`, `[ner]`).
- **`published: true`** controls page visibility.
- **`process.markdown: false`** and **`process.twig: true`** disable Markdown rendering and enable Twig templates (used for dynamic collection pages like the topics index).
- **Relative links** to other pages use paths like `/students/2022/jakub_schwarc` or `/topics/hatespeech`.
## Configuration (`config/`)
- `config/plugins/` — GRAV plugin settings
- `config/themes/` — Theme configuration
## Themes (`themes/`)
- `knowledge-base/` — Primary knowledge-base theme
- `mytheme/` — Custom theme