Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Consider removing the distinction between document and nested types

Aberta
#225 0 comentários 1 reação 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
25/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
typescript

Direção de pesquisa

Comece pela referência de makeSource para documentTypes e analise a proposta de terminologia na issue #226. Determine os pontos de entrada afetados das definições de tipos e da API e, em seguida, estabeleça o modelo e a terminologia acordados antes da implementação; considera-se concluído quando a distinção da API tiver sido removida de forma consistente ou quando a proposta tiver sido resolvida com uma decisão documentada.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
TypeScript
Estrelas
3.5k
Forks
192
Métricas de merge de PRs
Nenhum PR com merge em 30d

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de contentlayerdev/contentlayer

Todas as issues de contentlayerdev/contentlayer

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.