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

Add connect-node interceptor docs. #128

Merged
merged 6 commits into from
Feb 28, 2024
Merged

Add connect-node interceptor docs. #128

merged 6 commits into from
Feb 28, 2024

Conversation

srikrsna-buf
Copy link
Member

Add connect-node interceptor documentation. Will merge after we release.

Copy link

vercel bot commented Jan 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
connect ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 5, 2024 3:15pm

Copy link
Member

@timostamm timostamm left a comment

Choose a reason for hiding this comment

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

Nice, but the example for context values is not straight-forward to follow (see comments below), and we need to make sure that the concepts of interceptors, context, context values and keys are all easily discoverable and mentioned at the relevant places.

In Node.js / Server Plugins / Common options, we need to add the new interceptors option, and link to the new Interceptors page for details.

On the same page, we also need to document the option contextValues for each of the server plugins, and also link to the new page.

In Web / Interceptors, we also need a sub-section for context values, and we need to document document CallOption.contextValues there.

docs/node/interceptors.md Outdated Show resolved Hide resolved
docs/node/interceptors.md Show resolved Hide resolved
docs/node/interceptors.md Outdated Show resolved Hide resolved
docs/node/interceptors.md Outdated Show resolved Hide resolved
docs/node/interceptors.md Outdated Show resolved Hide resolved
docs/node/interceptors.md Outdated Show resolved Hide resolved
docs/node/interceptors.md Show resolved Hide resolved
docs/node/interceptors.md Outdated Show resolved Hide resolved
docs/node/interceptors.md Show resolved Hide resolved
docs/node/interceptors.md Outdated Show resolved Hide resolved
docs/node/interceptors.md Outdated Show resolved Hide resolved
docs/node/interceptors.md Outdated Show resolved Hide resolved
@srikrsna-buf srikrsna-buf marked this pull request as ready for review February 28, 2024 19:19
@srikrsna-buf srikrsna-buf merged commit 1d49b0e into main Feb 28, 2024
4 checks passed
@srikrsna-buf srikrsna-buf deleted the sk/es/interceptors branch February 28, 2024 19:20
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