metosin/compojure-api

New documentation site

Open

#329 aberto em 28 de jul. de 2017

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Clojure (149 forks)batch import
enhancementhelp wanted

Métricas do repositório

Stars
 (1.120 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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)

Guia do colaborador

Direção de pesquisa
Revise as issues referenciadas (#312, #188, #251, #155) para entender os requisitos de documentação. Explore o conteúdo do wiki existente e a estrutura de documentação do repositório. Decida um gerador de site estático (por exemplo, Jekyll, Hugo ou uma ferramenta baseada em Clojure como Cryogen) e planeje a hierarquia de conteúdo. Em seguida, implemente o novo site e atualize os links.
Pilha de tecnologia
clojure
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
3-5 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70