add docs for ddn plugins #1028
add docs for ddn plugins #1028
Conversation
|
@BenoitRanque Thanks for your PR! I've assigned @robertjdominguez to review it. |
DX: Assertion Testing✅ DiffThe PR's diff adds comprehensive information about configuring and understanding the behavior of pre-ndc-request and pre-ndc-response plugins. Each addition is clearly outlined, providing practical examples, use cases, and explicit details on plugin behavior, request structure, and response handling. Proper links to detailed configurations are also included, making it easy for users to navigate relevant sections. However, it may be beneficial to clarify the implications of the 'operationType' and 'ndcVersion' fields in the sample requests, as their roles are not immediately clear. ✅ IntegratedThe new documentation integrates well with the existing set of files, enhancing the overall usability of the documentation. The structured approach—starting from explaining the plugin hooks, followed by their configuration, request/response formats, and use cases—allows users to sequentially understand the concept. The clear mapping between the diff and the architecture diagram in the introduction is commendable. One suggestion for improvement would be to cross-reference related sections more extensively; for instance, when discussing webhook customization options, it could be useful to directly link to the section discussing the structure and configuration of |
Deploying ddn-docs with
|
| Latest commit: |
c14c57c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d467c66c.v3-docs-eny.pages.dev |
| Branch Preview URL: | https://ndc-plugins-docs.v3-docs-eny.pages.dev |
There was a problem hiding this comment.
@BenoitRanque — thanks for this!
I've approved it, but please see the note around metadata reference docs and how their content is generated.
| @@ -67,18 +67,17 @@ definition: | |||
|
|
|||
| ## Metadata structure | |||
There was a problem hiding this comment.
FYI — everything in these pages below this h2 is updated dynamically using this Action.
There was a problem hiding this comment.
That's my bad. In terms of actionable feedback, should I remove that section, or leave it as is, or do something else?
There was a problem hiding this comment.
I'm going to assume we can merge as-is, and the action will simply overwrite that whole section. Which is fine
Description 📝
Quick Links 🚀
Assertion Tests 🤖
a user should be able to understand how to configure a pre-ndc-request plugin
a user should be able to understand how to configure a pre-ndc-response plugin
a user should be able to understand the behavior expected of a webhook handling pre-ndc-request calls
a user should be able to understand the behavior expected of a webhook handling pre-ndc-response calls