[generics-rep] Add expanded documentation

Offen
#240 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
45/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
PureScript
Sterne
168
Forks
90
Ø Merge
3 T. 1 Std.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

  • Kein Dockerfile und keine Docker-Compose-Datei
  • Hat eine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus purescript/purescript-prelude

Alle Issues in purescript/purescript-prelude

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.