[generics-rep] Add expanded documentation

Aberta
#240 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
45/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Domínio
documentation

Direção de pesquisa

Read the library guidelines documentation section and the two referenced commits from documentation PR 338 to identify the proposed guides for generics-rep. Then check how core libraries structure expanded documentation and whether the referenced content is still suitable; done means adding the agreed guides in that structure. The issue has no comments or linked pull requests, so check whether the proposal is still current before starting.

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

Descrição

type: documentation

The purescript-contrib library guidelines suggest an expanded documentation directory. If we follow that same structure for the core libs (like generics-rep), then I'd like to add these guides on how to derive from generic:
https://github.com/purescript/documentation/pull/338/commits/9409b9a047aaa176199053928177c92739566a72
https://github.com/purescript/documentation/pull/338/commits/bb30b1514c406ee24eb6796d86ba282de323c4b7

That content was originally proposed for the language reference in https://github.com/purescript/documentation/pull/338

Linguagem predominante
PureScript
Estrelas
168
Forks
90
Merge médio
3d 1h
PRs com merge (30d)
1

Preparar o ambiente

  • Sem Dockerfile nem arquivo Docker Compose
  • Tem um modelo de pull request
  • Sem 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 purescript/purescript-prelude

Todas as issues de purescript/purescript-prelude

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

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