[Bug]: docs links sometimes have incorrect extension
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 38/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start at the linked FastAPI documentation page and inspect the “see starlette integration” link, then compare it with the side-menu destination. Done when that link reaches the same Starlette page as the side menu without a 404.
Written by the indexing model from the issue text.
Description
Actual Behavior
If I visit https://openapi-core.readthedocs.io/en/latest/integrations/fastapi.html and click "see starlette integration"
Then I get a 404, because the extension is .rst
https://openapi-core.readthedocs.io/en/latest/integrations/starlette.rst
Expected Behavior
When I use the side-menu, I can navigate to the same page.
Additionally on the 404 page, I don't have a menu, so I have to use the browser back-button, or delete the path, before navigating to https://openapi-core.readthedocs.io/en/latest/integrations/starlette.html
Steps to Reproduce
visit https://openapi-core.readthedocs.io/en/latest/integrations/fastapi.html
scroll to the bottom of the main content page.
click on the "see starlette integration" link
404 😢
OpenAPI Core Version
main
OpenAPI Core Integration
docs
Affected Area(s)
docs
References
this is your documentation page https://openapi-core.readthedocs.io/en/latest/integrations/fastapi.html
Anything else we need to know?
No thanks, but this has been quite a journey to fill out as a user.
Would you like to implement a fix?
No
- Dominant language
- Python
- Stars
- 368
- Forks
- 140
- PR merge metrics
- No merged PRs in 30d
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.
More from python-openapi/openapi-core
-
kind/bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
python-openapi/openapi-core#1188 · 2 comments ·
-
kind/bug
Difficulty 3/5 1-2 days Newbie friendliness 68/100
python-openapi/openapi-core#1225 · 2 comments ·
-
kind/bug
Difficulty 3/5 1-2 days Newbie friendliness 76/100
python-openapi/openapi-core#1212 ·
-
[Bug]: Query parameter validation fails to match empty string when listed as a valid enum value Openkind/bug
Difficulty 3/5 1-2 days Newbie friendliness 68/100
python-openapi/openapi-core#1210 ·
-
kind/bug kind/bug/confirmed
Difficulty 3/5 1-2 days Newbie friendliness 58/100
python-openapi/openapi-core#1180 · 3 comments ·
All issues in python-openapi/openapi-core
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DiamondLightSource/dodal#2211 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
openml/openml-python#1749 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
sipyourdrink-ltd/bernstein#6191 ·