-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New: Add "endpoints" guide #760
Copy link
Copy link
Closed
Labels
add new contentDocument something that is not in docs. May require testing, confirmation, or affect other pages.Document something that is not in docs. May require testing, confirmation, or affect other pages.tscguidance required from Technical Steering Committeeguidance required from Technical Steering Committee
Metadata
Metadata
Assignees
Labels
add new contentDocument something that is not in docs. May require testing, confirmation, or affect other pages.Document something that is not in docs. May require testing, confirmation, or affect other pages.tscguidance required from Technical Steering Committeeguidance required from Technical Steering Committee
Our guides for creating non-HTML pages (aka "endpoints") are pretty tough to scan as a new user. Right now, we have:
☝️ We also have different advice for endpoint return values for SSG vs. SSR. In SSR, we recommend a formatted
Responseobject with a defined content type. In SSG, you must use a{ body }object only (Responsewill break during builds) to output a static file. This speaks to a more fundamental issue with SSR, where it's more tacked-on than interwoven with our existing docs.Solution: a general "endpoints" docs page would be an excellent landing spot to compare SSG and SSR approaches to non-HTML files. We are beginning to encourage
.jsendpoints for any clientside data fetching as well, so a dedicated page for the concept should aid in onboarding SSR users.