Skip to content

chore: add AGENTS.md #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ShaunSHamilton merged 1 commit into from
Nov 10, 2026
Merged

chore: add AGENTS.md #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
This is a monorepo for the following:

| Location | Short Name | Long Name | Description |
| ---------------------------- | ---------- | -------------------- | ------------------------------------------------------------------------------------------ |
| `./apps/auth-api/` | `aAPI` | Auth API | HTTP REST API for `wApp` and `dApp` |
| `./apps/desktop-app/` | `dApp` | Desktop App | Tauri desktop app candidates take the exams on |
| `./apps/examiner-dashboard/` | `eDd` | Examiner Dashboard | Fullstack web app for staff to create and edit exams, and moderate and grade exam attempts |
| `./apps/web-app/` | `wApp` | Web App | Static web app where candidates register accounts and exam attempts |
| `./databases/curriculum/` | `cDb` | Curriculum Database | Dolt database and configuration with SDK for exam content |
| `./databases/examiner/` | `eDb` | Examiner Database | Postgres configuration and SDK for `eDd` and `aAPI` data |
| `./libs/object-storage/` | - | Object Storage crate | Rust crate for the S3-compatible storage solutions for non-text data |
| `./libs/runtime/` | - | Runtime crate | Rust crate for common rust APIs in server setup |

## LLM/Agentic Conventions

Never write code comments. All code comments should be human-written.

Do not touch Markdown content in `./docs/`. The `check-docs` skill can be used to bring up changes that need to be made.