Add docs for the Renderer API#13715
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
|
|
||
| A renderer is a special kind of [integration](/en/reference/integrations-reference/) that tells Astro how to detect and render component syntaxes it does not handle natively, such as [UI framework components](/en/guides/framework-components/). A renderer consists of two parts: | ||
| - a server module imported during development and production builds to render components to HTML. | ||
| - an optional client module imported in the browser to hydrate components with [client directives](/en/reference/directives-reference/#client-directives). |
There was a problem hiding this comment.
great explanation of these two things
matthewp
left a comment
There was a problem hiding this comment.
Definitely much better than what we had before. Great job!
Co-authored-by: Matthew Phillips <matthewphillips@cloudflare.com>
yanthomasdev
left a comment
There was a problem hiding this comment.
LGTM! Amazing work @ArmandPhilippot!
|
If even Yan doesn't have nitpicks about the wording, I guess this one is ready to be shipped! Thank you both for the reviews! I guess the sidebar reorganization (my third point in "Feedback welcome") can wait (NWTWWHB), especially since Fred wants to do some clean up around third-party guides. Perhaps he has other changes in mind. |
Description (required)
Adds a new reference page for the Renderer API:
SSRManifest.pageModule.rendererswas removed in v6, the type was a leftover from fix(v6): update integrations reference with v6 changes #13164serverEntrypoint/clientEntrypointin the Renderer API, so we might not need a third description in the Integration API, and I'm not sure the React link was helpful? (ie. this was old content, maybe it was useful at that time)Feedback welcome:
We don't want to show complex code snippets, but something that is enough to understand how this works. I tried to provide minimal code snippets based on the existing renderers but I'm not sure if this is too minimal or not.
It seems
/en/reference/renderer-referenceexisted before, so I had to update the redirections. I'm not sure how Netlify handles them... maybe we want another slug for the page to avoid any conflicts?I wonder if it would make sense to have a new sidebar group for integration-related APIs instead of lengthening the list in "Other development APIs"? Something like:

Related issues & labels (optional)