In our docs, we have a hook which fetches the current framework, however, there were other bits of code around the codebase which do similar things, and the hook was becoming unwieldy and difficult to follow.
I refactored the useFramework hook to make it easier to use, and improve the separation of concerns on the homepage docs.
Expo and React Native do not ship a TextDecoder implementation. This docs update explains how to polyfill for (huge) performance improvements in native apps.
The Jazz docs have code examples that hide certain lines to keep things simple. In the Svelte permissions guide, a “hide this line” marker was only hiding the first line of a multi-line block of code, leaving extra lines visible that shouldn’t have been shown. I fixed the formatting so the right lines are hidden.
We had some small issues with the new vanilla docs because the snippets were created before the big refactoring of code snippets was merged. This PR brought them in line with the framework specific snippets.
Jazz’s documentation had a missing asterisk in a role permissions table, which meant a footnote reference wasn’t displaying correctly. I added the missing character to fix the formatting.
Vercel’s Workflow SDK helps you build long-running background tasks. SvelteKit (a web framework) generates a build folder called .svelte-kit that should be ignored by tools watching for file changes. I added it to the ignore list so the workflow SDK doesn’t unnecessarily process those generated files.
We have an example chat app for all our supported frameworks. For our browser-based frameworks, this chat allows also uploading images to the chat, but our mobile apps did not.
I added the image upload functionality to the mobile framework examples.
Users can create lists using Jazz, but there’s no protection to stop users from inserting the same item multiple times into a CoList. For users wanting lists of unique items, I proposed and wrote up a pattern for using a CoRecord keyed on the CoValue ID.
The Jazz homepage stopped building after a recent change added a new dependency that made a previously-needed TypeScript workaround invalid. I removed the outdated workaround and added a proper type check, which got the homepage building and deploying again.
Jazz is a framework for building collaborative apps. “Workflow World” is a Jazz feature that lets you run backend tasks and workflows. I wrote the documentation for it, covering how to get started, how to set up webhooks, and how to self-host it.
At some point, I introduced a regression that was causing our homepage docs to enter into a recursive navigation loop calling useEffect multiple times. This quick PR fixed it.
I was quite pleased with the PR title on this one: “…infinite recursion: a fix to prevent…”
Twoslash is a code-highlighting and type-checking plugin which helps to make sure all our code samples are kept up to date. Unfortunately though, it causes our build times to be very slow.
I extracted all of our code samples into separate files, and developed a new way of integrating them into our docs. This led to huge speed wins, bringing our build times down by around 5 minutes per build (on Vercel), roughly 14 hours of compute per month.
It also brought even more significant savings in terms of development. Where previously, it took me (M4 Macbook Pro) 110s to compile the docs in dev mode, now it takes 7s, a speed increase of 15×, making it much easier to develop our homepage and our docs overall.
Currently, Jazz stores secrets in localStorage. This is accessible by client-side JavaScript, and so any untrusted code running in a developers’ app could allow the secret to be extracted. Although this is a required trade-off in order to avoid re-authenticating every single session, users are now warned about the risk of cross-site scripting, and advised to take steps to prevent it.
The Jazz documentation had a page about codecs (tools for converting data between formats) that had become unlinked and unreachable from the navigation menu. I moved it under the “Schemas” section where it logically belongs and re-added the link so people can find it again.
Jazz intelligently de-duplicates loads, meaning that each part of an application can load exactly what data it needs without worrying about what is loaded elsewhere in the app. The user will not pay a performance hit because only the extra data which is not already loaded will be fetched, and the existing loaded data will not be reloaded.
Jazz is a framework for building collaborative apps. It has various data types that developers use to build features, but one of them — SingleCoFeedEntry — wasn’t being made available for outside use even though similar types were. I exported it so developers can actually use it in their own code.
I was getting annoyed with Zed not showing any feedback when I tried to commit changes using Cmd+Enter. I made the button appear greyed out when there’s a commit operation pending.
Zed is a high-performance code editor. When you made a Git commit from within Zed’s built-in Git panel, there was no visual indication that anything was happening if it took a moment. Users would sometimes click the button repeatedly, thinking it hadn’t worked. I changed the button text to appear dimmed while a commit is in progress, so you can tell it’s working.
I added some detail to our existing docs showing how users who are not using a framework (‘vanilla’ users) can get started with Jazz.
In our Performance Tips section, I added a section telling users that if they’re adding a lot of values, they can improve performance by inserting them simultaneously in a single call, rather than iterating and inserting each one separately.