Skip to content

docs: document Snapchat Web Lenses for the web-lens starter and the Editor - #1302

Merged
willeastcott merged 3 commits into
mainfrom
docs/web-lens-starter
Oct 25, 2026
Merged

willeastcott merged 3 commits into
mainfrom
docs/web-lens-starter

Conversation

@willeastcott

@willeastcott willeastcott commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Documents publishing PlayCanvas games to Snapchat as Web Lenses, and updates the create-playcanvas guide for the web-lens starter and create-playcanvas 0.11.1. The Snapchat launch blog post links readers to the create-playcanvas page, which still said there were 12 starters and didn't mention the new one.

Snap's own Web Lens docs already cover the platform rules, the Web Lens API and the publishing process, using PlayCanvas throughout, and those rules are still changing in beta. So these pages cover only what's specific to PlayCanvas, for each product, and link to Snap's docs for the rest.

  • Code projects (Engine, React, Web Components): Start with create-playcanvas gets a Snapchat Web Lens Starter section. It covers what the starter handles, how to make it your own, packaging with npm run package, and where to upload.
  • Editor projects: a new Editor > Publishing > Snapchat Web Lenses page, next to Playable Ads, covers adding snap-api.js with Loading Type set to Before Engine, downloading and zipping the build, and uploading it. The Editor's Where can I publish PlayCanvas games? list links to it, and the two pages link to each other.
  • Start with create-playcanvas:
    • adds the Snapchat Web Lens starter to the Games row
    • documents two 0.11.1 changes: production builds use relative URLs, and runs without a terminal take the defaults
    • drops the hard-coded starter count, here and in Getting Started, since it goes stale whenever a starter is added
  • LLM indexes: the Engine index links to the starter section and the Editor index links to the Editor page. The entries point to the pages rather than restating them, and the root index is unchanged.
  • Japanese: both locales are updated, with heading IDs that match the English anchors.

npm run lint, npm test and npm run build pass, and the build has no warnings. It generates both locales of the new page and its Markdown version, and the #snapchat-web-lens-starter anchor that the Editor page links to exists in both locales.

Manual smoke test:

  1. Open Getting Started > Start with create-playcanvas. The Games row lists Snapchat Web Lens, and the Snapchat Web Lens Starter section shows the scaffold and npm run package commands and links to the Editor page.
  2. Open PlayCanvas Editor > Publishing. The list includes Snapchat Web Lenses, and the sidebar lists it after Playable Ads.
  3. Open Snapchat Web Lenses. It covers adding the Web Lens API, zipping the build and uploading it, and links back to the starter section.
  4. Switch the site to Japanese and repeat steps 1-3. The same information appears in Japanese.

I confirm I have read the contributing guidelines.

🤖 Generated with Claude Code

Adds Getting Started > Build a Snapchat Web Lens, which covers the
platform requirements, the create-playcanvas web-lens starter, the Web
Lens API in code projects and the Editor, packaging and uploading.

Updates Start with create-playcanvas for create-playcanvas 0.11.1: the
Snapchat Web Lens starter, relative production builds and runs without
a terminal taking the defaults. Drops the hardcoded starter count there
and in Getting Started, links the guide from the sidebar and the root,
Engine and Editor LLM indexes, and updates the Japanese translations.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…tion

A Web Lens can be built with any PlayCanvas product, so the guide moves
out of Getting Started into a new Publishing section under Common
Topics, as Snapchat Web Lenses. The section's overview links to the
Editor's own publishing pages, which link back to the guide.

The Getting Started overview no longer mentions the guide, the root LLM
index no longer links it, and the Engine index covers the new section.
The legacy redirect from /user-manual/publishing/ to the Editor's
publishing index now skips that one path, which the new section uses.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@willeastcott willeastcott changed the title docs: add a Snapchat Web Lens guide and the web-lens starter docs: add a Snapchat Web Lenses guide in a shared Publishing section Oct 25, 2026
The Publishing section under Common Topics had one page, and that page
mostly restated Snap's own rules for building a Lens. This splits the
PlayCanvas-specific parts by product and links Snap's docs for the rest:

- Start with create-playcanvas gets a Snapchat Web Lens Starter section
  that covers what the starter handles, npm run package and where to
  upload, for Engine, React and Web Components projects.
- Editor > Publishing gets a Snapchat Web Lenses page on publishing an
  Editor build: adding snap-api.js before the engine, zipping the
  downloaded build and uploading it.

Removes the Publishing section, its sidebar label translation and the
redirect exception it needed, and routes the Engine and Editor LLM
indexes to the two new places.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@willeastcott willeastcott changed the title docs: add a Snapchat Web Lenses guide in a shared Publishing section docs: document Snapchat Web Lenses for the web-lens starter and the Editor Oct 25, 2026
@willeastcott
willeastcott merged commit 1ddb7bc into main Oct 25, 2026
4 checks passed
@willeastcott
willeastcott deleted the docs/web-lens-starter branch October 25, 2026 15:31

This branch was successfully deployed

1 active deployment
Preview — 5256c17a Deployed Oct 25, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant