[nav.ts] New sidebar sections: built-ins and add-ons #5213
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
src/i18n/en/nav.ts
Outdated
| }, | ||
| { text: 'Server-side Rendering', slug: 'guides/server-side-rendering', key: 'guides/server-side-rendering' }, |
There was a problem hiding this comment.
This is my only complaint! Seems like Server-side Rendering should be under Built-ins. I know this section is getting revamped, but I don't think it's an add-on.
There was a problem hiding this comment.
Ah, I see there is discussion happening in Discord about this point.
There was a problem hiding this comment.
Mirroring discussion on Discord: because it requires adding an adapter, conceptually this falls closer to UI Frameworks because it doesn't work without something that needs to be astro added. So, literally, adding something for SSR to work is what makes it an add on. This category would be restricted to things very closely coupled to Astro's core offering, like our official packages where we also document their usage.
So noted, but as @delucis mentioned, from the outside looking in, "all you know is adding X makes SSR work" and I don't think this placement diminishes that it is something that is built into Astro core (but is helpful in understanding that it needs to be "unlocked" in order to actually use it.
And yes, I'd like this page to eventually be replaced with our Rendering Modes page, which maybe DOES go into basics, and then maybe we also keep an SSR page here that is devoted mostly to adding the adapter, marking individual pages in or out of pre-rendering etc.
|
Big fan of the change! |
those are just thoughts, all in all, it got much better over time. |
|
@wassfila Even the Node adapter has to be added! (FYI) |
|
Final decision after consultation with the team: SSR label in sidebar changed to "SSR Adapters" in keeping with the idea of the adapter being the "add on", and less to imply stuff about our actual rendering modes. This is a non-content/breaking change that only moves items in the sidebar. But, the plan is to augment this and allow us to include a "Rendering Mode" explanatory page in basics, and eventually this SSR page will in fact be geared towards enabling and using the adapters |
The file `nav.ts` has been updated to align with the English language documentation based on this commits withastro#4876 , withastro#5183 , withastro#5213 , withastro#5271 , withastro#5187 , withastro#4667 , withastro#5541 , withastro#5605 , withastro#5499 , withastro#6470 , withastro#6620
Description (required)
Adds two new sections to our main sidebar: Built-ins and Add-ons.
This intends to better highlight the natural progression of learning about Astro: Basics > not basic, but included stuff you probably want > things you can add-on that are part of our story: framework islands and hyping our rendering options
Play around and see what you think!
Current Docs -> Proposal:
