Bad practice recommended with Hono + Pages

[Cherry]

Existing documentation URL(s)

https://developers.cloudflare.com/pages/framework-guides/deploy-a-hono-site/

What changes are you suggesting?

This page is encouraging users to use Hono to serve assets. This is bad practice. It'll cause an unnecessary Worker invocation (and therefore potentially additional fees for users), instead of using something like Pages Functions Routing, or _routes.json.

It's also extremely confusing to end-users why and how Pages is used here.

Additional information

No response

[gshirescf]

cc: @megaconfidence @craigsdennis

[megaconfidence]

@yusukebe what's the best way to serve static assets using Hono and Workers Assets?

[yusukebe]

Hi @megaconfidence

I recommend the directory pattern.

• Create a ./public directory in your project.
• Add your asset files to it.
• Set up the wrangler.toml like below.
• /static/foo.txt will return ./public/static/foo.txt.

name = "my-worker"
main = "src/index.ts"
compatibility_date = "2024-09-19"
assets = { directory = "public" }

We (Hono contributors) also have to update the Hono docs: https://hono.dev/docs/getting-started/cloudflare-workers#serve-static-files

[yusukebe]

For Cloudflare Pages, we can use this doc:

https://hono.dev/docs/getting-started/cloudflare-pages

But there is one problem. This does not use C3 because it does not have a Pages template for Hono; it has only a Workers template. So in the doc, it uses create-hono directly, not wrapped by C3:

npm create hono@latest my-app

[yusukebe]

We (Hono contributors) also have to update the Hono docs: https://hono.dev/docs/getting-started/cloudflare-workers#serve-static-files

Updated: honojs/website#505

[kodster28]

Howdy @ToriLindsay, this looks like we also need to update the current hono page in our docs (listed above) to match the changes implemented in https://github.com/honojs/website/pull/505/files

[ToriLindsay]

Hi @Cherry - This issue appears to have been resolved by #20982. I'm going to close it now, but feel free to open a new issue or ask any questions.