vmware/pyvmomi

Improve Documentation Navigation

Open

#166 建立於 2014年9月15日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Python (2,141 star) (807 fork)batch import
documentationenhancementhelp wanted

描述

Based on this question we should probably work on ways to make it easier to forward and backwards navigate property hierarchies.

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Investigate the current documentation structure of pyvmomi, particularly the property hierarchy pages. Look at how forward and backward navigation could be added, possibly using breadcrumbs or links. Refer to the linked issue #164 for user feedback. Consider implementing a sidebar or table of contents that allows easy traversal.