[Bug]: docs links sometimes have incorrect extension

Offen
#881 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
38/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

area/documentation kind/bug kind/bug/confirmed
Actual Behavior

If I visit https://openapi-core.readthedocs.io/en/latest/integrations/fastapi.html and click "see starlette integration"
Screenshot 2024-07-31 at 07 12 11
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

Vorherrschende Sprache
Python
Sterne
368
Forks
140
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python-openapi/openapi-core

Alle Issues in python-openapi/openapi-core

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.