Docs backlog (#49)

Author: RarerAirError

docs/capabilities/blocks/app_image_assets.md

@@ -1,4 +1,4 @@
-# Adding Images
+# Adding images
 
 Add images to your interactive post.
 

docs/capabilities/blocks/blocks_payments.md

@@ -1,4 +1,4 @@
-# Adding Payments
+# Adding payments
 
 You can use the payments template to build your app or add payment functionality to an existing app.
 
@@ -42,7 +42,7 @@ Each product in the products field has the following attributes:
 | `sku` | A product identifier that can be used to group orders or organize your products. Each sku must be unique for each product in your app. |
 | `displayName` | The official name of the product that is displayed in purchase confirmation screens. The name must be fewer than 50 characters, including spaces. |
 | `description` | A text string that describes the product and is displayed in purchase confirmation screens. The description must be fewer than 150 characters, including spaces. |
-| `price` | An predefined integer that sets the product price in Reddit gold. See details below. |
+| `price` | An predefined integer that sets the product price in Reddit Gold. See details below. |
 | `image.icon` | **(optional)** The path to the icon that represents your product in your assets folder. |
 | `metadata` | **(optional)** An optional object that contains additional attributes you want to use to group and filter products. Keys and values must be alphanumeric (a - Z, 0 - 9, and - ) and contain 30 characters or less. You can add up to 10 metadata keys. Metadata keys cannot start with "devvit-". |
 | `accountingType` | Categories for how buyers consume your products. Possible values are: <ul><li>`INSTANT` for purchased items that are used immediately and disappear.</li><li>`DURABLE` for purchased items that are permanently applied to the account and can be used any number of times</li><li>`CONSUMABLE` for items that can be used at a later date but are removed once they are used.</li><li>`VALID_FOR_` values indicate a product can be used throughout a period of time after it is purchased.</li></ul> |
@@ -74,7 +74,7 @@ You’ll need to clearly identify paid products or services. Here are some best
 - Use a short name, description, and image for each product.
 - Don’t overwhelm users with too many items.
 - Try to keep purchases in a consistent location or use a consistent visual pattern.
-- Only use the gold icon to indicate purchases for Reddit gold.
+- Only use the gold icon to indicate purchases for Reddit Gold.
 
 ### Product image
 

docs/capabilities/client/forms.mdx

@@ -152,7 +152,7 @@ A form lets your app ask users to input and submit data. Forms can be defined wi
   </TabItem>
 </Tabs>
 
-## Menu Response Forms
+## Menu response forms
 
 For forms that open from a menu item, you can use menu responses. This is useful since you do not have access to the `@devvit/web/client` library from a menu item endpoint.
 

docs/capabilities/client/menu-actions.mdx

@@ -1,13 +1,13 @@
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-# Menu Actions
+# Menu actions
 
 Add an item to the three dot menu for posts, comments, or subreddits. Menu actions can perform immediate client effects or trigger server processing followed by client effects.
 
 ![Subreddit menu actions](../../assets/capabilities/menu-actions/menu-actions-subreddit.png)
 
-## Basic Menu Actions
+## Basic menu actions
 
 **For most menu actions, use direct client effects.** These provide immediate responses and are perfect for simple actions that don't require server processing.
 
@@ -121,7 +121,7 @@ context.ui.showForm(surveyForm);
 </TabItem>
 </Tabs>
 
-## Supported Contexts
+## Supported contexts
 
 You can decide where the menu action shows up by specifying the location property.
 

docs/capabilities/client/overview.mdx

@@ -1,7 +1,7 @@
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Overview
+# Client Overview
 
 Client-side effects enable your Devvit app to provide interactive feedback and navigation to users. These effects include showing toasts, displaying forms, navigating to different pages, and more.
 

docs/capabilities/devvit-web/devvit_web_configuration.md

@@ -1,4 +1,4 @@
-# Configure Your App
+# Configure your app
 
 The devvit.json file serves as your app's configuration file. Use it to specify entry points, configure features like [event triggers](../server/triggers) and [scheduled actions](../server/scheduler.mdx), and enable app functionality such as [image uploads](../server/media-uploads.mdx). This page covers all available devvit.json configuration options. A complete devvit.json example file is provided [here](#complete-example).
 

docs/capabilities/devvit-web/devvit_web_overview.mdx

@@ -34,10 +34,11 @@ As with most experimental features, there are some caveats.
 
 | Limitation                                       | What it means                                                                                                                                                                                                                                                                                           |
 | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Serverless endpoints                             | The node server will run just long enough to execute your endpoint function and return a response, which means you can’t use packages that require long-running connections like streaming.                                                                                                             |
+| Serverless endpoints                             | The node server will run just long enough to execute your endpoint function and return a response, which means you can't use packages that require long-running connections like streaming.                                                                                                             |
 | Package limitations                              | Developers cannot use `fs` or external native packages. For now, we recommend using external services over the native dependencies, such as [StreamPot](https://streampot.io/) (instead of ffmpeg) and [OpenAI](https://platform.openai.com/docs/guides/embeddings) (instead of @xenova/transformers) . |
-| Single request and single response handling only | Streaming or chunked responses and websockets are not supported. Long-polling is supported if it’s under the max request time.                                                                                                                                                                          |
-| No external requests from your client            | You can’t have any external requests other than the app's webview domain. All backend responses are locked down to the webview domain via CSP. (Your backend can make external fetch requests though.)                                                                                                  |
+| Single request and single response handling only | Streaming or chunked responses and websockets are not supported. Long-polling is supported if it's under the max request time.                                                                                                                                                                          |
+| No external requests from your client            | You can't have any external requests other than the app's webview domain. All backend responses are locked down to the webview domain via CSP. (Your backend can make external fetch requests though.)                                                                                                  |
+| localStorage clears on app updates               | The iframe URL changes with each app version, so `localStorage` data is lost when you publish an update. Use [Redis](../server/redis.mdx) for data that needs to persist across app versions.                                                                                                           |
 
 Devvit Web still has the same technical requirements:
 

docs/capabilities/server/cache-helper.mdx

@@ -1,7 +1,7 @@
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Cache Helper
+# Cache helper
 
 Cache helper lets you build a more performant app by reducing the number of server side calls for the same data. You can create a short-term cache that stores JSON objects in your Devvit app for a limited amount of time. This is valuable when you have many clients trying to get the same data, for example a stock ticker value or a sports score.
 

docs/capabilities/server/launch_screen_and_entry_points/launch_overview.mdx

@@ -1,4 +1,4 @@
-# Overview
+# View Modes, Launch Screens, and Entry Points
 
 Devvit’s interactive framework gives you powerful ways to shape how users experience apps, from launch screen to expanded screen viewing. With view modes, HTML-based launch screens, and multiple entry points, you can design apps that feel native and respond to how users interact across the Reddit platform.
 

docs/capabilities/server/launch_screen_and_entry_points/view_modes_entry_points.md

@@ -1,6 +1,6 @@
-# Setting up View Modes and Entry Points
+# Setting up view modes and entry points
 
-## View Modes
+## View modes
 
 Devvit apps support two view modes:
 
@@ -18,7 +18,7 @@ Devvit apps support two view modes:
 - **Use case**: Full games, longer load times, detailed interfaces, or any content that needs more space or full gesture support
 - **Trigger**: User-initiated only (button click, gesture, etc.)
 
-## Multiple Entry Points
+## Multiple entry points
 
 Multiple entry points let the user start the game from different contexts or states. For example, you can have a button that launches into a leaderboard view and another for a specific game mode, each of these would be configured as an entry point for your app. Define multiple entry points in your `devvit.json`. If you use the [Devvit Vite plugin](../../../guides/tools/vite), it automatically infers the client build inputs from these entrypoints, so you don't need to maintain a custom Rollup `input` list.
 
@@ -78,7 +78,7 @@ your-app/
 
 The `dir` property specifies where your built client files are located. With the Devvit Vite plugin, the `entry` values point at your source HTML files (for example `src/client/preview.html`), and the plugin outputs the matching files into `dist/client` during `vite build`.
 
-### Creating Posts with Specific Entry Points
+### Creating posts with specific entry points
 
 Use the `entry` parameter when creating posts to specify which entry point from your `devvit.json` configuration to use. The entry value must match one of the keys defined in `post.entrypoints`.
 
@@ -118,7 +118,7 @@ async function createGamePost(context: any) {
 - Each entry point can have its own HTML file and height setting.
 - Invalid entry point names will cause an error.
 
-### Switching Between View Modes
+### Switching between view modes
 
 You can transition from inline mode to expanded mode with a different entry point, like this:
 
@@ -135,7 +135,7 @@ const handleStartGame = async (event: React.MouseEvent) => {
 };
 ```
 
-## Inline Mode Requirements
+## Inline mode requirements
 
 All Devvit web view apps load in inline mode by default. Your app loads directly in the post unit without requiring users to click to expand.