Repository overview template

The landing page of a repository section, at docs/repos/<repo>/index.md. Its frontmatter also feeds the repository switcher, the Repositories menu and the repository list on the home page. icon can be any name from docs/.vitepress/icons.mjs, and order sets the position in those lists.

Generated by npm run new:repo.

Template

---
title: "{{repoName}}"
description: "{{description}}"
github: {{github}}
icon: {{icon}}
order: {{order}}
status: draft
cards:
  - { title: Architecture, text: "How the repository is structured and how its parts interact.", link: ./architecture, icon: layers }
  - { title: Modules, text: "Modules and packages, one page each.", link: ./modules/, icon: boxes }
  - { title: Components, text: "UI and service components, one page each.", link: ./components/, icon: component }
  - { title: Functions, text: "Important functions and helpers.", link: ./functions/, icon: function }
  - { title: APIs, text: "Endpoints, commands and service interfaces.", link: ./apis/, icon: api }
  - { title: Configuration, text: "Environment variables, config files and secrets.", link: ./configuration, icon: settings }
  - { title: Dependencies, text: "Other repositories, services and packages it relies on.", link: ./dependencies, icon: package }
  - { title: Contributing, text: "Local setup, workflow, standards and release.", link: ./contributing, icon: users }
---

# {{repoName}}

{{description}}

<LinkCards :items="$frontmatter.cards" :cols="4" />

## What this repository is

TODO: Two to four sentences: what this repository is responsible for, who or
what depends on it, and where it sits in the Ediky ecosystem.

## At a glance

| Field | Value |
| --- | --- |
| Repository | `{{github}}` |
| Primary language | TODO |
| Runtime / hosting | TODO |
| Deploys to | TODO |
| Owners | TODO |
| Status | TODO: active / maintenance / experimental |

## Tech stack

TODO: Languages, frameworks, key libraries, build tooling and hosting.

## Repository layout

TODO: Top-level folders, one line each.

```text
{{repoSlug}}/
├── TODO/        TODO: purpose
├── TODO/        TODO: purpose
└── TODO         TODO: purpose
```

## Getting started

TODO: Prerequisites, then the commands to install, run and test locally.
Details go in [Contributing](./contributing).

```bash
# TODO: clone, install, run
```

## Related documentation

- [Architecture](./architecture)
- [Repository dependencies](/cross-repo/dependencies)
- [Cross-repository data flow](/cross-repo/data-flow)
- TODO: Links to the repositories this one talks to.

Placeholders

{{repoName}}     Display name, e.g. ediky-website
{{repoSlug}}     Folder name under docs/repos/, kebab-case
{{description}}  One-line description
{{github}}       GitHub path, e.g. EdikyLab/ediky-website
{{icon}}         Icon name from docs/.vitepress/icons.mjs
{{order}}        Sort position in lists (lower first)