[docs] Add link to package overview at the top of each Python class documentation
- Dominant language
- TypeScript
- Stars
- 12.9k
- Forks
- 4.6k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 71
Description
**Add link to Package Overview page in each Python class documentation. Mention that it contains examples.**
Most of the usage examples are captured in package overview. On the other hand, when customers are searching for usage examples, they navigate straight to the relevant class, don't find the examples there, and give up (don't think to look in package overview). Adding a link to package overview at the top of each class page, mentioning that it contains examples, might shorten the implementation time for customers.
---
This is a 📕 documentation issue
Contributor guide
Research direction
No files, tests, or entry points are named in the issue. Begin by locating the generated Python class reference pages and their package overview pages; done means each class page links to the package overview and states that it contains examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100