contentlayerdev / contentlayerdev/contentlayer

Consider removing the distinction between document and nested types

Abierto
#225 0 comentarios 1 reacción 0 asignados Ver en GitHub
meta: feedback-wanted meta: never-stale
Lenguaje dominante
TypeScript
Estrellas
3.5k
Forks
192
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

From the beginning, we've separated the idea of _documents_ and _nested_ types. The primary difference between these types is that:

- Document types define the shape of built content files
- Nested types define shapes of content used _within_ built content files

We may be able to simplify the API by considering every type definition as just that — a type definition. We already have to define [`documentTypes`](https://www.contentlayer.dev/docs/reference/source-files/make-source#documenttypes) when calling `makeSource`. Could this be the way in which documents are defined, while every other type is just a type.

#226 contains a way we could adjust terminology if making this change to help with the language we're using.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.