Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Consider removing the distinction between document and nested types

Ouverte
#225 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Fonctionnalité
Clarté
À clarifier
Activité
À l'abandon
Stack technique
typescript

Piste de recherche

Commencez par la référence makeSource pour documentTypes et examinez la proposition de terminologie dans l’issue #226. Déterminez les points d’entrée concernés des définitions de types et de l’API, puis établissez le modèle et la terminologie convenus avant l’implémentation ; le travail est considéré comme terminé lorsque la distinction de l’API a été supprimée de manière cohérente ou que la proposition a été résolue par une décision documentée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
TypeScript
Étoiles
3.5k
Forks
192
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de contentlayerdev/contentlayer

Toutes les issues de contentlayerdev/contentlayer

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.