docs: improvements + additions to module docs #9152
Conversation
shahednasser
commented
Sep 16, 2024
shahednasser
commented
- Split Module and Module Links to their own chapters
- Add new docs on db operations and transactions in modules, multiple services, links with custom columns, etc...
- Added a list of registered dependencies in a module container
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
|
This PR currently has a merge conflict. Please resolve this and then re-add the |
| const retrieveBrandsStep = createStep( | ||
| "retrieve-brands", | ||
| async (_, { container }) => { | ||
| const brandModuleService = container.resolve( | ||
| "brandModuleService" | ||
| ) | ||
|
|
||
| const brands = await brandModuleService.listBrands() | ||
|
|
||
| return new StepResponse(brands) | ||
| } | ||
| ) |
There was a problem hiding this comment.
nit(non blocking): should we show the useRemoteQueryStep?
There was a problem hiding this comment.
In this case I want to showcase the usage of the different modules, so I think it's fine to not use useRemoteQueryStep.
|
|
||
| const cmsBrands = await cmsModuleService.createBrands(brands) | ||
|
|
||
| return new StepResponse(cmsBrands, cmsBrands) |
There was a problem hiding this comment.
suggestion: it is not necessary to pass both args if they are the same, by default the compensation input will be the first arg if the second is not provided
There was a problem hiding this comment.
I know, but I've avoided documenting this to avoid confusion.
www/apps/book/app/advanced-development/modules/isolation/page.mdx
Outdated
Show resolved
Hide resolved
www/apps/book/app/advanced-development/module-links/custom-columns/page.mdx
Outdated
Show resolved
Hide resolved
|
@olivermrbl can we get this one in? |
- Split Module and Module Links to their own chapters - Add new docs on db operations and transactions in modules, multiple services, links with custom columns, etc... - Added a list of registered dependencies in a module container
- Split Module and Module Links to their own chapters - Add new docs on db operations and transactions in modules, multiple services, links with custom columns, etc... - Added a list of registered dependencies in a module container
