metosin/compojure-api

New documentation site

Open

#329 geöffnet am 28. Juli 2017

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Clojure (149 Forks)batch import
enhancementhelp wanted

Repository-Metriken

Stars
 (1.120 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

new separate site with new docs for 2.0.0, to replace the current wiki.

  • meta(was: #312)
  • deployment (was: #188)
  • nil body handling (was: #251)
  • no-AOT-docs (was: #155)

Contributor Guide

Research-Richtung
Überprüfen Sie die referenzierten Issues (#312, #188, #251, #155), um die Dokumentationsanforderungen zu verstehen. Erkunden Sie die vorhandenen Wiki Inhalte und die Dokumentationsstruktur des Repositorys. Entscheiden Sie sich für einen Static Site Generator (z. B. Jekyll, Hugo oder ein Clojure basiertes Tool wie Cryogen) und planen Sie die Inhaltshierarchie. Implementieren Sie dann die neue Website und aktualisieren Sie die Links.
Tech Stack
clojure
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70