[generics-rep] Add expanded documentation

Ouverte
#240 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
45/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Domaine
documentation

Piste de recherche

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.

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

Description

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

Langage dominant
PureScript
Étoiles
168
Forks
90
Merge moyen
3 j 1 h
PR mergées (30 j)
1

Préparer son environnement

  • Aucun Dockerfile ni fichier Docker Compose
  • Propose un modèle de pull request
  • Aucun guide de contribution

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 purescript/purescript-prelude

Toutes les issues de purescript/purescript-prelude

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

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