contentlayerdev / contentlayerdev/contentlayer

Consider removing the distinction between document and nested types

Aperta
#225 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
meta: feedback-wanted meta: never-stale
Lingua principale
TypeScript
Stelle
3.5k
Fork
192
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.