metosin/compojure-api

New documentation site

Open

#329 建立於 2017年7月28日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)Clojure (1,120 star) (149 fork)batch import
enhancementhelp wanted

描述

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)

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
over 1 week
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
needs investigation
前置要求
Basic knowledge of the project's APIFamiliarity with documentation tools
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
15
研究方向
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.