metosin/compojure-api

New documentation site

Open

#329 opened on Jul 28, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Clojure (1,120 stars) (149 forks)batch import
enhancementhelp wanted

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

Tech stack
None
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.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Basic knowledge of the project's APIFamiliarity with documentation tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
15
Research direction
This issue aims to create a new documentation site for version 2.0.0, replacing the current wiki. It references several sub issues (#312, #188, #251, #155) that should be reviewed. To start, examine the existing wiki (https://github.com/metosin/compojure api/wiki) and the project's structure to understand what needs to be documented. Consider using a static site generator like MkDocs or Docusaurus. The issue is stale, so check if there are any recent discussions or plans.