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

docs: middleware refresh #3266

Merged
merged 1 commit into from Mar 6, 2024
Merged

Conversation

wolovim
Copy link
Member

@wolovim wolovim commented Mar 5, 2024

What was wrong?

  • docs for creating custom middleware were hidden within the web3 internals page
  • nitpicky stuff

How was it fixed?

  • all middleware-related docs now live in the middleware page
  • nitpicky updates, including referring to plural middleware, without the s ;) note the API still has a few cases where middlewares appears with an s. a problem for not this PR.

Todo:

Cute Animal Picture

Put a link to a cute animal picture inside the parenthesis-->

@wolovim wolovim requested a review from fselmo March 5, 2024 18:16
@wolovim wolovim force-pushed the docs-middleware-consolidate branch from 5a658e0 to 5535a6c Compare March 5, 2024 18:27
Copy link
Collaborator

@fselmo fselmo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nits but looks good. Much better condensed into one page 👍🏼

docs/middleware.rst Outdated Show resolved Hide resolved
docs/middleware.rst Outdated Show resolved Hide resolved
docs/middleware.rst Outdated Show resolved Hide resolved
docs/middleware.rst Outdated Show resolved Hide resolved
docs/middleware.rst Outdated Show resolved Hide resolved
docs/middleware.rst Outdated Show resolved Hide resolved
docs/middleware.rst Outdated Show resolved Hide resolved
docs/middleware.rst Outdated Show resolved Hide resolved
docs/middleware.rst Outdated Show resolved Hide resolved
docs/middleware.rst Outdated Show resolved Hide resolved
@wolovim wolovim force-pushed the docs-middleware-consolidate branch from 5535a6c to c873446 Compare March 6, 2024 17:12
@wolovim wolovim force-pushed the docs-middleware-consolidate branch from c873446 to eb1eec3 Compare March 6, 2024 17:18
@wolovim
Copy link
Member Author

wolovim commented Mar 6, 2024

@fselmo thanks for the feedback. tweaks made, plus moved the API definition up above the list of default middleware. felt like an awkward jump from default middleware -> API definition -> optional middleware.

@wolovim wolovim requested a review from fselmo March 6, 2024 17:23
Copy link
Collaborator

@fselmo fselmo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great. It's much more cohesive as one page. lgtm 👍🏼

@wolovim wolovim merged commit 098e3d7 into ethereum:main Mar 6, 2024
81 of 85 checks passed
@wolovim wolovim deleted the docs-middleware-consolidate branch March 6, 2024 17:40
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.

None yet

2 participants