Consider removing the distinction between document and nested types

Offen

#225 erstellt am 17.5.2022 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 25/100

Issue-Typ: Feature
Klarheit: Muss geklärt werden
Aktivitätsstatus: Veraltet
Tech-Stack: typescript
Bereich: backend-api-design

Rechercherichtung

Beginne mit der makeSource-Referenz für documentTypes und prüfe den Terminologievorschlag in Issue #226. Ermittle die betroffenen Typdefinitions- und API-Einstiegspunkte und lege dann das vereinbarte Modell und die Terminologie vor der Implementierung fest; abgeschlossen bedeutet, dass die API-Unterscheidung entweder konsistent entfernt wurde oder der Vorschlag mit einer dokumentierten Entscheidung geklärt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

meta: feedback-wanted meta: never-stale

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 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.

Vorherrschende Sprache: TypeScript
Sterne: 3.5k
Forks: 192
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus contentlayerdev/contentlayer

Error when building with contentlayer 0.3.4 and Next.js 13 App Router Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 25/100

contentlayerdev/contentlayer#506 · 84 Kommentare · 47 Reaktionen · Erstellt am 07.7.2023
Poor/broken monorepo DX: can't specify .contentlayer/ output path, no docs for custom config path Offen

help wanted meta: never-stale needs-research

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 38/100

contentlayerdev/contentlayer#464 · 4 Kommentare · 9 Reaktionen · Erstellt am 26.5.2023
State of the project Offen

meta: never-stale

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 10/100

contentlayerdev/contentlayer#429 · 49 Kommentare · 83 Reaktionen · Erstellt am 24.4.2023
Process markdown in computed fields Offen

meta: never-stale topic: markdown/mdx

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 42/100

contentlayerdev/contentlayer#421 · 4 Reaktionen · Erstellt am 11.4.2023
Attaching references after the build Offen

meta: never-stale needs-research topic: schema

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

contentlayerdev/contentlayer#420 · Erstellt am 11.4.2023

Alle Issues in contentlayerdev/contentlayer