freeCodeCamp/devdocs

Add docs for mc-stan.org

Open

#1,752 建立於 2022年5月17日

在 GitHub 查看
 (7 留言) (0 反應) (0 負責人)Ruby (38,907 star) (2,598 fork)batch import
docs/new+requesthelp wanted

描述

Feature request

I am adding this issue to let people know that I am starting work on importing documentation for mc-stan.org. I had previously proposed this documentation on the gitr channel and got positive feedback for the idea.

Summary

The mc-stan documentation is somewhat similar to the scikit-learn documentation, and it is split into several parts:

  1. User's guide
  2. Stan language reference
  3. Stan functions reference
  4. User guides for projects building on top of Stan
  5. Case studies
  6. Tutorials

I think points 1.-3. could be added to devdocs.io. I think point 3. is lowest hanging fruit, so I will start with that.

The documentation for 1-3 is located at https://github.com/stan-dev/docs

貢獻者指南

技術棧
ruby
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
RubyDevdocs scraping framework
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50
研究方向
Examine existing Devdocs scrapers for similar documentation sources (e.g., scikit learn) to understand the required format. Review the MC Stan documentation repository (https://github.com/stan dev/docs) to locate the functions reference HTML files. Implement a new scraper based on the pattern used by other scrapers in the Devdocs project.