Commit Graph
16 Commits
Author SHA1 Message Date
Charis 33924f0e62 fix: remove frontmatter and repeated H1 from wrappers docs (#28704) 2024-08-16 17:41:17 +00:00
Charis e67c219120 fix(docs): api crawler routes (#28614) 2024-08-14 12:16:02 -04:00
Charis fc164b5d07 Refactor/app router refs (#28095)
Migrates client SDK References to App Router. (Management and CLI API references aren't migrated yet, nor are self-hosting config references.)

Some notes:

Big changes to the way crawler pages are built and individual section URLs (e.g., javascript/select) are served. All of these used to be SSG-generated pages, but the number of heavy pages was just too much to handle -- slow as molasses and my laptop sounded like it was taking off, and CI sometimes refuses to build it all at all.

Tried various tricks with caching and pre-generating data but no dice.

So I changed to only building one copy of each SDK+version page, then serving the sub-URLs through a response rewrite. That's for the actual user-visible pages.

For the bot pages, each sub-URL needs to be its own page, but prebuilding it doesn't work, and rendering on demand from React components is too slow (looking for super-fast response here for SEO). Instead I changed to using an API route that serves very minimal, hand-crafted HTML. It looks ugly, but it's purely for the search bots.

You can test what bots see by running curl --user-agent "Mozilla/5.0 (iPhone; CPU iPhone OS 6_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10A5376e Safari/8536.25 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)" <URL_OF_PAGE>

Also added some smoke tests to run against prod for the crawler routes, since we don't keep an eye on those regularly, and Vercel config changes could surprise-break them. Tested the meta images on Open Graph and all seems to work fine.

With this approach, full production builds are really fast: ~5 minutes

Starts using the new type spec handling, which is better at finding params automatically, so I could remove some of the manually written ones from the spec files.
2024-08-13 16:12:59 -04:00
Bo Lu 2af2a132e6 docs: change wrappers docs dir for new docs pages (#28472) 2024-08-09 00:43:05 +10:00
Bo LuandCharis Lam 4c6f93f253 docs: add Snowflake and Paddle foreign data wrappers (#28305)
* docs: add Snowflake and Paddle foreign data wrappers

* docs: add links to left nav menu

* add wasm fdw intro

* fix: inline code wrapping in table cells

* adjust wording

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2024-08-02 10:37:54 +10:00
Charis 837e314088 feat(docs): add visual contributing guide (#28214)
Add a contributing guide to docs, which links to resources for contributors
and includes examples of usable components when writing docs content.
2024-07-26 15:54:20 -04:00
Kevin Grüneberg 33142c2340 chore: type imports / avoid barrel file (#28100) 2024-07-23 09:55:41 +08:00
Kang Ming dd702704df docs: relocate auth0 migration guide (#28081) 2024-07-19 12:58:51 -04:00
Francesco Sansalvadore 084294fe79 feat: docs breadcrumbs (#27929)
docs guides breadcrumbs
2024-07-15 10:25:13 +02:00
Charis 9fb97becb9 fix: revalidate fetches every day (#27828)
The Vercel Data Cache caches data across deployments, and we want to
check for updates in federated content, so let's revalidate the data
once a day.

It may be more efficient to revalidate on-demand, since we don't change
most of these sources once a day, but that requires setting up an API
endpoint (and figuring out how to authenticate it), so this is
quick-and-easy for now.
2024-07-08 13:12:19 -04:00
Charis 282bd2c73f enhance: move not-found data fetch to client side (#27781)
Fetching recommendations on the server takes too long before the first
load, so it's faster to load the basic not-found page and generate the
recommendations on the client side.
2024-07-04 15:23:19 +00:00
Francesco Sansalvadore 0d657df42e feat: docs global top nav (#26917)
Docs global top nav
2024-07-04 11:51:13 +02:00
Charis 4b9817cba9 chore: remove data cache from not-found docs page (#27780) 2024-07-03 12:10:01 -04:00
Charis f4779d4844 refactor: migrate guides to app router (#23101)
Migrate guides to App Router.
2024-07-03 10:25:06 -04:00
Giuseppe Davide Tancaanddavide.tanca e2bc80ac8d fix(docs): broken references links (#27630)
Co-authored-by: davide.tanca <davide.tanca@ext.illimity.com>
2024-06-28 18:50:23 -04:00
Charis ac192a5024 refactor(docs): migrate home page to app router (#27221) 2024-06-24 18:47:53 -04:00