Proposal: store docs.json in the registry

Aberta
#704 21 comentários 0 reações 1 responsável Ver no GitHub

Mantenedores costumam responder em até 1 dia

@thomashoneyman já está trabalhando nisso.

Desde 27/7/2026.

  • #791 de @thomashoneyman — aberto

Avaliação

Esta issue ainda não foi avaliada.

Descrição

pursuit

As part of #525 should we consider storing docs.json in the registry?

  • The registry pipeline is already compiling projects with an appropriate compiler. We can easily add the appropriate codegen targets.
  • The registry pipeline is the sole publisher to Pursuit nowadays. It seems unnecessary to support additional authentication workflows in Pursuit.
  • If we store docs metadata in the registry, pursuit largely becomes a stateless registry client in principle, even though it likely needs to build it's own index.
  • We have more freedom to adjust the actual format (especially wrt metadata) since the registry controls the data end-to-end.

Questions:

  • Where is this actually stored? Package metadata is stored in a single-file ldjson format, but we would want to store version specific files, likely.
  • Are there format changes we need to make? Is there redundant information in the data we currently publish to Pursuit that is otherwise available in the registry?
  • We may need a data migration from pursuit-backups.
  • We may need some additional postback mechanism to notify Pursuit of newly published packages if we don't want to rely on a cron job that pulls the registry metadata.
Linguagem predominante
PureScript
Estrelas
95
Forks
79
Merge médio
16h 13min
PRs com merge (30d)
14

Preparar o ambiente

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 purescript/registry-dev

Todas as issues de purescript/registry-dev

Receba novas issues na sua caixa de entrada

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