Skip to content

Section index template ​

The table of contents for one section of a repository, such as docs/repos/<repo>/modules/index.md. The sidebar already lists every page in the folder. This page adds one line of context per entry.

Generated by npm run new:repo for modules/, components/, functions/ and apis/.

Template ​

md
---
title: "{{sectionTitle}}"
description: "{{sectionDescription}}"
status: draft
---

# {{sectionTitle}}

{{sectionDescription}}

| {{singular}} | Purpose | Source | Status |
| --- | --- | --- | --- |
| TODO: link to page | TODO | `TODO: path` | TODO: draft / documented |

## Adding a page

Create one page per {{singularLower}} in this folder. It appears in the sidebar
automatically.

```bash
npm run new:page -- {{repoSlug}} {{kind}} <page-slug> "<Title>"
```

To create it by hand, copy the [{{singularLower}} template](/templates/{{kind}})
to `docs/repos/{{repoSlug}}/{{folder}}/<page-slug>.md`.

Placeholders ​

text
{{sectionTitle}}        Modules | Components | Functions | APIs
{{sectionDescription}}  One line describing what goes in this section
{{singular}}            Module | Component | Function | API
{{singularLower}}       module | component | function | API
{{kind}}                module | component | function | api
{{folder}}              modules | components | functions | apis
{{repoSlug}}            Folder name under docs/repos/

Ediky Workflow — internal engineering documentation.