Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix relative path on middleware doc #1600

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nogtk
Copy link

@nogtk nogtk commented Nov 20, 2024

Description

I found the link to each included middleware from middleware/index.md was broken, it's defined as a relative path so we don't need middleware directory.

The following pages provide detailed configuration for the middleware that ships with Faraday:
* [Authentication](middleware/included/authentication.md)
* [URL Encoding](middleware/included/url-encoding.md)
* [JSON Encoding/Decoding](middleware/included/json.md)
* [Instrumentation](middleware/included/instrumentation.md)
* [Logging](middleware/included/logging.md)
* [Raising Errors](middleware/included/raising-errors.md)

Todos

nothing special

Additional Notes

nothing special

@nogtk nogtk marked this pull request as ready for review November 20, 2024 01:29
@olleolleolle
Copy link
Member

@nogtk I was looking at the rendered website, and those links do refer to the right pages, they seem to do the right thing.

Are you referring to "how the Markdown pages work when rendered on GitHub" or "how to website works when it is rendered"?

Does the change in this PR keep the behaviour of the rendered website?

Here is the section on available middleware and I was able to follow the links.
https://lostisland.github.io/faraday/#/middleware/index?id=available-middleware

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants