Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[nav.ts] New sidebar sections: built-ins and add-ons #5213

Merged
merged 4 commits into from
Oct 27, 2023
Merged

[nav.ts] New sidebar sections: built-ins and add-ons #5213

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8aa1886
built-ins and add-ons
sarah11918 Oct 27, 2023
08d50d8
update new header keys
sarah11918 Oct 27, 2023
e18f385
emphasize adapters in nav
sarah11918 Oct 27, 2023
2a84059
Merge branch 'main' into sidebar-new-sections
sarah11918 Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 26 additions & 30 deletions src/i18n/en/nav.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,56 +46,52 @@ export default [
},
{ text: 'Pages', slug: 'core-concepts/astro-pages', key: 'core-concepts/astro-pages' },
{ text: 'Layouts', slug: 'core-concepts/layouts', key: 'core-concepts/layouts' },

{ text: 'Recipes', header: true, type: 'learn', key: 'examples' },
{ text: 'Migrate to Astro', slug: 'guides/migrate-to-astro', key: 'guides/migrate-to-astro' },
{ text: 'Connect a CMS', slug: 'guides/cms', key: 'guides/cms' },
{ text: 'Add backend services', slug: 'guides/backend', key: 'guides/backend' },
{ text: 'Add integrations', slug: 'guides/integrations-guide', key: 'guides/integrations-guide' },
{ text: 'Deploy your site', slug: 'guides/deploy', key: 'guides/deploy' },
{ text: 'More recipes', slug: 'recipes', key: 'guides/recipes' },

{ text: 'Guides', header: true, type: 'learn', key: 'features' },
{
text: 'Astro Template Syntax',
slug: 'core-concepts/astro-syntax',
key: 'core-concepts/astro-syntax',
},
{
text: 'UI Frameworks',
slug: 'core-concepts/framework-components',
key: 'core-concepts/framework-components',
},
{ text: 'Routing', slug: 'core-concepts/routing', key: 'core-concepts/routing' },
{ text: 'Markdown & MDX', slug: 'guides/markdown-content', key: 'guides/markdown-content' },

{ text: 'Built-ins', header: true, type: 'learn', key: 'examples' },
{
text: 'Content Collections',
slug: 'guides/content-collections',
key: 'guides/content-collections',
},
{
text: 'Scripts & Event Handling',
slug: 'guides/client-side-scripts',
key: 'guides/client-side-scripts',
text: 'View Transitions',
slug: 'guides/view-transitions',
key: 'guides/view-transitions',
},

{ text: 'Add-ons', header: true, type: 'learn', key: 'examples' },
{ text: 'Add integrations', slug: 'guides/integrations-guide', key: 'guides/integrations-guide' },
{
text: 'UI Frameworks',
slug: 'core-concepts/framework-components',
key: 'core-concepts/framework-components',
},
{ text: 'Server-side Rendering', slug: 'guides/server-side-rendering', key: 'guides/server-side-rendering' },
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see there is discussion happening in Discord about this point.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


{ text: 'Recipes', header: true, type: 'learn', key: 'examples' },
{ text: 'Migrate to Astro', slug: 'guides/migrate-to-astro', key: 'guides/migrate-to-astro' },
{ text: 'Connect a CMS', slug: 'guides/cms', key: 'guides/cms' },
{ text: 'Add backend services', slug: 'guides/backend', key: 'guides/backend' },
{ text: 'Deploy your site', slug: 'guides/deploy', key: 'guides/deploy' },
{ text: 'More recipes', slug: 'recipes', key: 'guides/recipes' },

{ text: 'Guides', header: true, type: 'learn', key: 'features' },
{ text: 'Routing', slug: 'core-concepts/routing', key: 'core-concepts/routing' },
{ text: 'Markdown', slug: 'guides/markdown-content', key: 'guides/markdown-content' },
{ text: 'Scripts & Event Handling', slug: 'guides/client-side-scripts', key: 'guides/client-side-scripts'},
{ text: 'CSS & Styling', slug: 'guides/styling', key: 'guides/styling' },
{ text: 'Images', slug: 'guides/images', key: 'guides/images' },
{ text: 'Fonts', slug: 'guides/fonts', key: 'guides/fonts' },
{ text: 'Imports', slug: 'guides/imports', key: 'guides/imports' },
{
text: 'Server-side Rendering (SSR)',
slug: 'guides/server-side-rendering',
key: 'guides/server-side-rendering',
},
{ text: 'Endpoints', slug: 'core-concepts/endpoints', key: 'core-concepts/endpoints' },
{ text: 'Data Fetching', slug: 'guides/data-fetching', key: 'guides/data-fetching' },
{ text: 'Middleware', slug: 'guides/middleware', key: 'guides/middleware' },
{ text: 'Testing', slug: 'guides/testing', key: 'guides/testing' },
{
text: 'View Transitions',
slug: 'guides/view-transitions',
key: 'guides/view-transitions',
},
{ text: 'Troubleshooting', slug: 'guides/troubleshooting', key: 'guides/troubleshooting' },

{ text: 'Configuration', header: true, type: 'learn', key: 'configuration' },
Expand Down