Project-MONAI / Project-MONAI/MONAI
Documentation index is not functioning well
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.7k
- Forks
- 1.6k
- Avg merge
- 5d 1h
- Merged PRs (30d)
- 20
Description
Describe the bug
In the official documentation website (i.e., API reference), the index on the right side is not working well. After clicking the desired title, it will jump to the correct location, but it will not span the list correctly.
Screenshots
Starting page:
after clickingUtilities, it works well and expand the list and shows its children:
after clicking Detection, it will jump to the location correctly, but the list is not expanded:
This can be annoying if I am not familiar with the API and want to check whether there is function I need. Hope this bug can be fixed in the next iteration.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the issue on the official documentation website's API reference, focusing on the right-side index and the Utilities and Detection entries shown in the screenshots. Investigate the documentation index navigation behavior; done means clicking an entry both jumps to the location and expands or scrolls the list correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100