Appearance
Repositories
Every repository in the EdikyLab organization has its own section here, and every section has the same shape. Once you've read one, you know where to find things in all of them.
ediky-websiteThe Ediky product: React SPA, Cloudflare Pages Functions, Workers and question-bank content.ediky-desktopDesktop client for Ediky, built with Tauri.ediky-sharedTODO: One-line description of what this repository provides.ediky_toolsTools for automating question generation and validation.DocyStorage for personalised Ediky notes, fetched by the app at runtime.ci-infraCentralized DevOps and GitOps infrastructure hub for the Ediky ecosystem.ediky-coreThis documentation portal (Ediky Workflow), built with VitePress.
Section structure
| Page | What it covers |
|---|---|
| Overview | What the repository is, at a glance, tech stack, layout, getting started |
| Architecture | System context, internal structure, key flows, design decisions |
| Modules | One page per module or package |
| Components | One page per UI or service component |
| Functions | One page per important function |
| APIs | One page per endpoint, command or service interface |
| Configuration | Environment variables, config files, secrets, environments |
| Dependencies | Other repositories, external services, key packages |
| Contributing | Local setup, workflow, standards, testing, release |
A section can drop a page that doesn't apply (for example, components/ in a repository with no UI). The sidebar follows the files on disk.
Adding a repository
bash
npm run new:repo -- <repo-slug> "<Display name>" "<One-line description>" --icon <icon> --order <n>The new repository appears here, in the sidebar switcher and in the Repositories menu without any config change. See Adding a Repository.