metosin/compojure-api

New documentation site

Open

#329 opened on Jul 28, 2017

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Clojure (149 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (1,120 stars)
PR merge metrics
 (No merged PRs in 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)

Contributor guide

Research direction
Review the referenced issues (#312, #188, #251, #155) to understand the documentation requirements. Explore the existing wiki content and the repository's documentation structure. Decide on a static site generator (e.g., Jekyll, Hugo, or a Clojure based tool like Cryogen) and plan the content hierarchy. Then implement the new site and update links.
Tech stack
clojure
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70