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.