[WIP] Cycle 4 Release

[jamesqquick]

• added getComponentSnapshot doc
• added <Slot>
• added <MakeswiftComponent> doc
• updated installation guides
  • Pages Router
  • App Router
• deployment guides for Vercel and Netlify
• re-organized navigation sidebar
  • added Functions section
  • added Deploying section
  • moved Localization section to Guides section
  • grouped App Router and Pages Router for both Installation and Localization under a group
• add getSiteVersion doc under Functions section in sidebar

[migueloller]

The example code snippet getSiteVersion has a lot going on. Does Mintlify support highlighting certain areas of the code?

[jamesqquick]

@migueloller for getSiteVersion snippet, I was thinking about trying something much more minimal to your point about it being busy. It then links to the Installation guide for a more in depth walkthrough. Let me know what you think about that.

[migueloller]

@migueloller for getSiteVersion snippet, I was thinking about trying something much more minimal to your point about it being busy. It then links to the Installation guide for a more in depth walkthrough. Let me know what you think about that.

I think showing it at the top-level that way might be a bit misleading given that it can only be used on RSCs or Route Handlers. What if we did this?

The example below renders the home page at the default locale. For a more comprehensive example check...

import { Page } from '@makeswift/runtime/next'
import { client } from '@/lib/makeswift'

export default function Page() {
  const snapshot = await client.getPageSnapshot('/', {
    siteVersion: siteVersion(),
  })

  if (snapshot == null) notFound()

  return <Page snapshot={snapshot} />
}

Is that too busy?

[migueloller]

I started adding suggestions where I found usage of getSiteVersion but there were enough where it made sense to stop and let you take care of it. Also, we'll want to update other instances of that like the URL get-site-version, etc.

I'm silly. The API is indeed getSiteVersion. I was thinking too much about the cookies and headers APIs from Next.js and what we wanted to name our function longterm that I thought we had named it siteVersion...

[jamesqquick]

@migueloller were you originally thinking it should be siteVersion() instead of getSiteVersion()? So nothing I need to change with those right?

For the code snippet on getSiteVersion, I think what you have is perfect. Great suggestion!

[migueloller]

@migueloller were you originally thinking it should be siteVersion() instead of getSiteVersion()? So nothing I need to change with those right?

For the code snippet on getSiteVersion, I think what you have is perfect. Great suggestion!

Yeah, the API should probably be siteVersion to match Next.js since they don't do getCookies or getHeaders. It's a breaking change that we won't do right now, though. I think we do it when we ship @makeswift/nextjs if we do have an API like it