index

Reconstrói o index.md de uma coleção: a folha gerada que lista os Blueprints dela para que uma pessoa ou um agente possam navegar sem varrer a árvore.

O que ele faz

Lê as coleções declaradas pelo Framework, percorre o único nível de subpastas de cada uma e reescreve cada index.md por inteiro: um link markdown por Blueprint com o summary de uma linha dele, agrupado por subpasta ou em nível único.

specs/index.md

# specs

<!-- index: specs (regenerated) -->

## playback
- [Watch a Video](playback/watch-a-video.md) — play a video reliably, signed in or not.
- [Resume Playback](playback/resume-playback.md) — returns a viewer to the exact second they stopped.

Ele regenera, não escreve

Cada linha é o summary do Blueprint, tal e qual. Um Blueprint sem ele é sinalizado, nunca inventado: um índice que em silêncio escreve uma linha plausível para você é um índice em que você já não pode confiar.

Quando executá-lo

Depois que Blueprints são acrescentados, renomeados, movidos ou removidos.

Nada depende de ele estar em dia: um índice desatualizado é um incômodo, não uma falha. Ele anota em vez de bloquear, como tudo o que é derivado no Eidos.

Como ele roda

Ele traz um build-index.py que faz a varredura inteira de forma determinística onde há shell disponível, e recorre a fazer isso à mão em um host isolado. De qualquer jeito a saída é a mesma.

Nota

Não há nada escrito à mão em um index.md para preservar. Qualquer coisa que você digite em um se perde na próxima execução, que é o teste de se algo pertence sequer a uma folha gerada.

Relacionado

• Folhas geradas: esta e o canvas, juntas.