修复文档中链接及显示问题

Question

文档的可获取方式和相互链接存在一些问题

• 目前大多数人可能都直接访问https://github.com/clojure/core.contracts并阅读README，但是它没有指向{{./docs/}} => 添加链接到那里
• 不清楚文档应以何种方式浏览；我猜测.org
  文件应该被导出到 * }，但并非所有文件都是如此。我还
  认为导出的markdown文件应该在https://github.com/clojure/core.contracts/wiki下可用，即推送至[email protected]:clojure/core.contracts.wiki.git
• 一些问题

   *  the link "return to documentation" on e.g. "with-constraints" should point to /clojure/core.contracts/wiki, not /clojure/core.contracts/docs.html
  

  • 如果wiki确实导出，主页应该提到它是不可变的
  • 主页上的链接 曾经 更多一次 'wiki' (在wiki中手动修复 - 将在下一次导出时被覆盖)
  • 一些链接是错误的，例如：(链接：defconstrainedfn)(/clojure/core.contracts/wiki/defconstrainedfn)在f.ex. {{contract}}; (链接：with-constraints)(/clojure/core.contracts/with-constraints/) (缺少 /wiki/), (链接：defcontract)(/clojure/core.contracts/wiki/defcontract/)

如果文档更易于访问和浏览的话，当然会对项目大有裨益 :-)

谢谢

Answer 1

参考：https://clojure.atlassian.net/browse/CCONTRACTS-5 (由 alex+import 报告)