vmware/pyvmomi

Improve Documentation Navigation

Open

#166 opened on Sep 15, 2014

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (2,141 stars) (807 forks)batch import
documentationenhancementhelp wanted

Description

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

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.