Add index page for client API documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 71
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 11
Description
Main Docs
The link to the Python Client API on the main docs page is broken.
The link here: https://rucio.github.io/documentation/#developer-documentation points to non-existent https://rucio.github.io/documentation/html/site/client.html
Python Client API Docs
The "Home" link in the top menu is broken in all python client api docs:
https://rucio.github.io/documentation/html/client_api/accountclient.html
It points to: https://rucio.github.io/documentation/html/client_api/ where no index file exists.
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
Inspect the documentation source that generates the main docs page and the Python client API pages linked in the issue. Start by tracing the broken client.html and client_api/ URLs, then verify that the main documentation link and every Python client API page's Home link resolve to an index page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100