Rewrite the docs
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- markdown, python
研究方向
Start with the beta docs source at github.com/reactive-python/reactpy/tree/new-docs and compare it with the live preview and React's beta documentation. Map the existing reStructuredText documentation before evaluating the Markdown conversion and the listed versioning, macros, and Jupyter plugins. Done means the documentation is rewritten 1:1 in the proposed format and the resulting docs are usable for beginners.
由索引模型根據 Issue 內容生成。
描述
Beta Docs Live Preview: https://reactive-python.github.io/reactpy/
Beta Docs Source Code: https://github.com/reactive-python/reactpy/tree/new-docs
Current Situation
It is difficult for new contributors to modify the docs, due to the current usage of reStructuredText (RST). Also the current verbiage is somewhat hard to understand for beginners.
Proposed Actions
Convert the current docs from reStructuredText (sphinx) to Markdown (mkdocs).
These new docs should be a 1:1 rewrite of ReactJS's documentation.
Also consider using these plugins
- https://github.com/jimporter/mike for docs versioning
- https://github.com/fralau/mkdocs_macros_plugin for code actions
- https://github.com/greenape/mknotebooks or https://github.com/danielfrg/mkdocs-jupyter for embedding jupyter into the page
Related issues
- #845
- #779
- #653
- #647
- #349
- #568
- #780
- 主要語言
- Python
- 星號
- 8.1k
- 分支
- 332
- PR 合併指標
- 30 天內沒有已合併 PR
貢獻指南
這個儲存庫沒有索引到貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
reactive-python/reactpy 的其他 Issue
-
priority-3-low type-docs
難度 2/5 1-3 小時 新手友好度 65/100
reactive-python/reactpy#1034 ·
-
priority-2-moderate type-revision
難度 5/5 一週以上 新手友好度 25/100
reactive-python/reactpy#1319 ·
-
priority-1-high
難度 5/5 一週以上 新手友好度 25/100
reactive-python/reactpy#1277 ·
-
priority-3-low
難度 5/5 一週以上 新手友好度 35/100
reactive-python/reactpy#1273 · 1 個 reaction ·
-
priority-2-moderate
難度 5/5 一週以上 新手友好度 30/100
reactive-python/reactpy#1272 · 2 個 reaction ·
查看 reactive-python/reactpy 的全部 Issue
相似的 Issue
-
難度 1/5 1 小時以內 新手友好度 90/100
-
bug
難度 2/5 1-3 小時 新手友好度 86/100
zostera/django-bootstrap4#894 ·
-
難度 2/5 1-3 小時 新手友好度 78/100
use-agent-os/agent-os#3276 ·
-
難度 2/5 1-3 小時 新手友好度 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
難度 2/5 1-3 小時 新手友好度 88/100
NousResearch/hermes-agent#117848 ·