oracle / oracle/oci-python-sdk

Duplicate Titles Found in Oracle Python SDK API Docs

Open
#782 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

SDK
Dominant language
Python
Stars
474
Forks
321
Avg merge
23m
Merged PRs (30d)
4

Description

Hi,

While reviewing the reference documentation for the Oracle Python SDK, I noticed that several section titles on the API landing page are duplicated, which can be confusing and reduces readability.

📄 Doc Link:
https://docs.oracle.com/en-us/iaas/tools/python/2.155.2/api/landing.html

🖼️ Screenshot:
Image

✅ This seems like a small formatting issue and should be easy to fix.

Thanks for your great work on the SDK!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by opening the linked Oracle Python SDK API landing page and compare the repeated section titles shown there with the documentation source or generation path in the repository. Identify where those titles originate and remove the duplication without changing the API content. Done means the landing page presents each section title once and remains readable.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.