Skip to content

Commit 897d37f

Browse files
authored
Fix relative links (#11)
## 💸 TL;DR Due to [how Docusaurus resolves links](https://docusaurus.io/docs/markdown-features/links), if we're linking to an internal Markdown file, we should be sure to include the extension. This ensures that when looking at a versioned doc, or looking at a page with a trailing slash, that the URLs still resolve correctly, as Docusaurus will replace the relative path with a correct, absolute path at build time. ## 🧪 Testing Steps / Validation `yarn build && yarn serve` locally worked great for me 👍
1 parent c81bfa8 commit 897d37f

File tree

38 files changed

+161
-161
lines changed

38 files changed

+161
-161
lines changed

docs/blocks/attributes/_color.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
A `string` for setting the color to any [Blocks-compatible color value](./colors). Possible values:
1+
A `string` for setting the color to any [Blocks-compatible color value](../colors.mdx). Possible values:
22

33
- HTML color names: `red`
44
- HEX: `#ff4500`

docs/blocks/overview.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ We support the following elements:
99
### Containers
1010

1111
- **Blocks**
12-
- [**HStack**](./stacks)
13-
- [**VStack**](./stacks)
14-
- [**ZStack**](./stacks)
12+
- [**HStack**](./stacks.mdx)
13+
- [**VStack**](./stacks.mdx)
14+
- [**ZStack**](./stacks.mdx)
1515

1616
### Objects
1717

18-
- [**Text**](./text)
19-
- [**Button**](./button)
20-
- [**Spacer**](./spacer)
21-
- [**Image**](./image)
22-
- [**Icon**](./icon)
18+
- [**Text**](./text.mdx)
19+
- [**Button**](./button.mdx)
20+
- [**Spacer**](./spacer.mdx)
21+
- [**Image**](./image.mdx)
22+
- [**Icon**](./icon.mdx)
2323

2424
Further elements (components) may be derived from these blocks, and obey the same rules.
2525

@@ -80,16 +80,16 @@ Grow elements are flexible. Whenever the full width (or height) of a parent elem
8080

8181
All elements inherit a direction for the purposes of growing. Things only grow in one direction at a time.
8282

83-
| Element | Self Direction | Child Direction |
84-
| ------------------ | -------------- | --------------- |
85-
| Blocks | N/A | Vertical |
86-
| [HStack](./stacks) | Inherit | Horizontal |
87-
| [VStack](./stacks) | Inherit | Vertical |
88-
| [ZStack](./stacks) | Inherit | Inherit |
89-
| [Text](./text) | Horizontal | N/A |
90-
| [Button](./button) | Horizontal | N/A |
91-
| [Spacer](./spacer) | Inherit | N/A |
92-
| [Image](./image) | Inherit | N/A |
83+
| Element | Self Direction | Child Direction |
84+
| ---------------------- | -------------- | --------------- |
85+
| Blocks | N/A | Vertical |
86+
| [HStack](./stacks.mdx) | Inherit | Horizontal |
87+
| [VStack](./stacks.mdx) | Inherit | Vertical |
88+
| [ZStack](./stacks.mdx) | Inherit | Inherit |
89+
| [Text](./text.mdx) | Horizontal | N/A |
90+
| [Button](./button.mdx) | Horizontal | N/A |
91+
| [Spacer](./spacer.mdx) | Inherit | N/A |
92+
| [Image](./image.mdx) | Inherit | N/A |
9393

9494
### Overflow
9595

docs/capabilities/blocks/overview.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ We support the following elements:
2727
### Containers
2828

2929
- **Blocks**
30-
- [**HStack**](../../../blocks/stacks)
31-
- [**VStack**](../../../blocks/stacks)
32-
- [**ZStack**](../../../blocks/stacks)
30+
- [**HStack**](../../blocks/stacks.mdx)
31+
- [**VStack**](../../blocks/stacks.mdx)
32+
- [**ZStack**](../../blocks/stacks.mdx)
3333

3434
### Objects
3535

36-
- [**Text**](../../../blocks/text)
37-
- [**Button**](../../../blocks/button)
38-
- [**Spacer**](../../../blocks/spacer)
39-
- [**Image**](../../../blocks/image)
40-
- [**Icon**](../../../blocks/icon)
36+
- [**Text**](../../blocks/text.mdx)
37+
- [**Button**](../../blocks/button.mdx)
38+
- [**Spacer**](../../blocks/spacer.mdx)
39+
- [**Image**](../../blocks/image.mdx)
40+
- [**Icon**](../../blocks/icon.mdx)
4141

4242
Further elements (components) may be derived from these blocks, and obey the same rules.
4343

@@ -98,16 +98,16 @@ Grow elements are flexible. Whenever the full width (or height) of a parent elem
9898

9999
All elements inherit a direction for the purposes of growing. Things only grow in one direction at a time.
100100

101-
| Element | Self Direction | Child Direction |
102-
| -------------------------------- | -------------- | --------------- |
103-
| Blocks | N/A | Vertical |
104-
| [HStack](../../../blocks/stacks) | Inherit | Horizontal |
105-
| [VStack](../../../blocks/stacks) | Inherit | Vertical |
106-
| [ZStack](../../../blocks/stacks) | Inherit | Inherit |
107-
| [Text](../../../blocks/text) | Horizontal | N/A |
108-
| [Button](../../../blocks/button) | Horizontal | N/A |
109-
| [Spacer](../../../blocks/spacer) | Inherit | N/A |
110-
| [Image](../../../blocks/image) | Inherit | N/A |
101+
| Element | Self Direction | Child Direction |
102+
|-----------------------------------| -------------- | --------------- |
103+
| Blocks | N/A | Vertical |
104+
| [HStack](../../blocks/stacks.mdx) | Inherit | Horizontal |
105+
| [VStack](../../blocks/stacks.mdx) | Inherit | Vertical |
106+
| [ZStack](../../blocks/stacks.mdx) | Inherit | Inherit |
107+
| [Text](../../blocks/text.mdx) | Horizontal | N/A |
108+
| [Button](../../blocks/button.mdx) | Horizontal | N/A |
109+
| [Spacer](../../blocks/spacer.mdx) | Inherit | N/A |
110+
| [Image](../../blocks/image.mdx) | Inherit | N/A |
111111

112112
### Overflow
113113

docs/capabilities/devvit-web/devvit_web_overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,4 +89,4 @@ All server endpoints must start with `/api/` (e.g. `/api/get-something` or `/api
8989

9090
`devvit.json` is the configuration file for Devvit apps. It defines an app's post configuration, Node.js server configuration, permissions, scheduled jobs, event triggers, menu entries, payments configuration, and project settings. `devvit.json` replaces the legacy `devvit.yaml` configuration. A project should have one or the other but not both.
9191

92-
Learn more about [devvit.json](./devvit_web_configuration)
92+
Learn more about [devvit.json](./devvit_web_configuration.md)

docs/capabilities/server/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Allows you to run automated server-side tasks on a schedule, for example, checki
2828

2929
Allows you to build an app where the moderator can store secret keys in a safe and scalable way. For example, if your app needs the installing moderator to provide their own keys to an external API.
3030

31-
## [Triggers](./triggers)
31+
## [Triggers](./triggers.mdx)
3232

3333
Allows you to run automated server-side tasks when certain events happen on Reddit, for example: when a new post is created, or when a new comment is created.
3434

docs/capabilities/server/post-data.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You can attach small amounts of data (2KB) to a post when creating it and update
88

99
Post data is useful for storing game state, scores, or any other information that needs to persist with the post and be shared across all users.
1010

11-
Post data is set when you submitPost and apps can access from the context object or do a server side call to update the post data on a Post object. For larger data, use [redis](./redis).
11+
Post data is set when you submitPost and apps can access from the context object or do a server side call to update the post data on a Post object. For larger data, use [redis](./redis.mdx).
1212

1313
:::note
1414
Post data is sent to the client. Never store secrets or sensitive information.

docs/changelog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ This release focuses on Reddit data access and instrumenting WebView clients
9696

9797
**Release Date: Nov 10, 2025**
9898

99-
Release 0.12.2 delivers a major evolution in how interactive Devvit apps load, display, and engage users. With this update, you can now leverage inline web views, in addition to expanded mode, to build your interactive posts with Devvit Web. We’re also deprecating [Splash Screens](./capabilities/server/launch_screen_and_entry_points/splash_migration) in favor of more customizable HTML inline launch screens.
99+
Release 0.12.2 delivers a major evolution in how interactive Devvit apps load, display, and engage users. With this update, you can now leverage inline web views, in addition to expanded mode, to build your interactive posts with Devvit Web. We’re also deprecating [Splash Screens](./capabilities/server/launch_screen_and_entry_points/splash_migration.mdx) in favor of more customizable HTML inline launch screens.
100100

101101
**Inline Mode**
102102

@@ -114,10 +114,10 @@ Devvit apps using inline web views are currently seeing inflated metrics in thei
114114

115115
Splash screens are yesterday’s news. The improved inline launch screens are now fully customizable, HTML-based entry points for your interactive posts. This update gives you control over design, animation, and loading behavior and uses the same tools and styles as the rest of your app.
116116

117-
The new first screen automatically loads before your app’s main entry point. Read the docs to learn how to [upgrade your app](./capabilities/server/launch_screen_and_entry_points/splash_migration) and [customize your launch screen](./capabilities/server/launch_screen_and_entry_points/launch_screen_customization).
117+
The new first screen automatically loads before your app’s main entry point. Read the docs to learn how to [upgrade your app](./capabilities/server/launch_screen_and_entry_points/splash_migration.mdx) and [customize your launch screen](./capabilities/server/launch_screen_and_entry_points/launch_screen_customization.md).
118118

119119
:::note
120-
**Deprecation notice**: We're deprecating the splash parameter in submitCustomPost() and removing it in the next major version update. Learn how to [update your app](./capabilities/server/launch_screen_and_entry_points/splash_migration).
120+
**Deprecation notice**: We're deprecating the splash parameter in submitCustomPost() and removing it in the next major version update. Learn how to [update your app](./capabilities/server/launch_screen_and_entry_points/splash_migration.mdx).
121121
:::
122122

123123
**Multiple App Entry Points**

docs/devvit_rules.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Your app is subject to our app review and approval. Reddit may reject or remove
1212

1313
These Devvit Rules are intended to clarify how we review Devvit apps and streamline the process for you and Reddit. Our goal is to keep redditors safe and enable developers to build fun and useful apps for redditors. This means our Devvit Rules may evolve over time, which you should keep in mind when building or updating your app. Please [reach out](https://developers.reddit.com/docs/help) if you have any questions on these Devvit Rules. Any exceptions to these Devvit Rules or any other Reddit Terms & Policies must be approved in writing by Reddit.
1414

15-
You can use Devvit and test your app without needing to submit it to Reddit’s App Review. However, to make your app visible in the [Reddit App Directory](https://developers.reddit.com/apps) and publicly available for other mods and admins to install, you’ll need prior app approval. Additionally, if you want to unlock premium features for your app (for example, [payments](./earn-money/payments/payments_overview), [fetching](./capabilities/server/http-fetch), or [using LLMs](#generative-aillm-rules)), you’ll also need prior app approval.
15+
You can use Devvit and test your app without needing to submit it to Reddit’s App Review. However, to make your app visible in the [Reddit App Directory](https://developers.reddit.com/apps) and publicly available for other mods and admins to install, you’ll need prior app approval. Additionally, if you want to unlock premium features for your app (for example, [payments](./earn-money/payments/payments_overview.md), [fetching](./capabilities/server/http-fetch.mdx), or [using LLMs](#generative-aillm-rules)), you’ll also need prior app approval.
1616

17-
You can start the Reddit app review process by [publishing your app](./guides/launch/launch-guide). Before starting a Reddit app review, we recommend:
17+
You can start the Reddit app review process by [publishing your app](./guides/launch/launch-guide.md). Before starting a Reddit app review, we recommend:
1818

1919
- Thoroughly playtesting your app,
2020
- Carefully reviewing these Devvit Rules and other Reddit Terms & Policies, and
@@ -44,7 +44,7 @@ You and your app(s) must:
4444
- Provide discrete functionality and always try to make Reddit more enjoyable
4545
- Maintain functionality that communities rely on, communicate when you cannot, and make it easy to contact you for support
4646
- Be transparent and use clear naming and descriptions that accurately describe your app’s functionality, purpose, and data practices
47-
- Include your own terms of service and privacy policy if your app uses premium features (for example, [payments](./earn-money/payments/payments_overview), [fetching](./capabilities/server/http-fetch), or [using LLMs](#generative-aillm-rules)) or if requested by Reddit
47+
- Include your own terms of service and privacy policy if your app uses premium features (for example, [payments](./earn-money/payments/payments_overview.md), [fetching](./capabilities/server/http-fetch.mdx), or [using LLMs](#generative-aillm-rules)) or if requested by Reddit
4848
- Provide accurate information about your relationship with Reddit or any other person or entity, including other developers (for example, by including them in your app description)
4949
- Test your app locally and in sandbox subreddits when applicable
5050
- Avoid enabling or allowing others to violate these Devvit Rules or other Reddit Terms & Policies
@@ -126,11 +126,11 @@ Your app must comply with all privacy and data protection requirements outlined
126126

127127
### Be careful using external sites or services
128128

129-
If your app uses [HTTP Fetch](./capabilities/server/http-fetch) or otherwise collects personal information about app users, we require you to have a terms of service and privacy policy and include a link to both in your app. Your terms of service and privacy policy must completely and accurately describe how you and your app collects, uses, shares, and stores data and why. (Please note that links to Reddit’s [User Agreement](https://redditinc.com/policies/user-agreement) and/or [Privacy Policy](https://www.reddit.com/policies/privacy-policy) will not be accepted.)
129+
If your app uses [HTTP Fetch](./capabilities/server/http-fetch.mdx) or otherwise collects personal information about app users, we require you to have a terms of service and privacy policy and include a link to both in your app. Your terms of service and privacy policy must completely and accurately describe how you and your app collects, uses, shares, and stores data and why. (Please note that links to Reddit’s [User Agreement](https://redditinc.com/policies/user-agreement) and/or [Privacy Policy](https://www.reddit.com/policies/privacy-policy) will not be accepted.)
130130

131131
If your app links to any third-party site that may collect redditor personal data, you are solely responsible for verifying the legitimacy and security of the third-party site and should ensure that they are in compliance with all applicable laws. For example, you should ensure that a site collecting personal data provides a privacy policy that clearly discloses what data is collected, how the data is used, and how the data is shared.
132132

133-
You’ll also need permission during app review to direct redditors outside of Reddit or otherwise collect personal information about them. To request HTTP Fetch functionality for a specific domain, please follow [these instructions](./capabilities/server/http-fetch).
133+
You’ll also need permission during app review to direct redditors outside of Reddit or otherwise collect personal information about them. To request HTTP Fetch functionality for a specific domain, please follow [these instructions](./capabilities/server/http-fetch.mdx).
134134

135135
## Content rules
136136

@@ -160,7 +160,7 @@ Whether your app uses existing user content or otherwise allows users to create
160160

161161
- _Account Deletions_ – When a user account is deleted, the related user ID (t2\_\*) must be completely removed from your hosted datastores (e.g., Redis) and any external systems. You must also delete all references to the author-identifying information (including the author ID, name, profile URL, avatar image URL, user flair, etc.) from posts and comments created by that account. You may continue to keep posts and comments created by deleted accounts, provided that the posts and comments have not been explicitly deleted.
162162

163-
- _Setting Up Auto-Deletion_ – To best comply with this policy, we recommend deleting any stored user data within 30 days. For any data you are storing in Redis, you can use the [expire function](./capabilities/server/redis#key-expiration) to ensure data gets deleted automatically.
163+
- _Setting Up Auto-Deletion_ – To best comply with this policy, we recommend deleting any stored user data within 30 days. For any data you are storing in Redis, you can use the [expire function](./capabilities/server/redis.mdx#key-expiration) to ensure data gets deleted automatically.
164164

165165
- **Enabling Deletions of New User Content** – if your app allows users to create new user content, you must ensure that users have the ability to remove their own content when desired and comply with all legal requirements related to content removals. It is important to have safety guardrails in place if your app allows users to create new user content so that the content can be reported and removed by app users.
166166

docs/earn-money/payments/payments_add.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Product prices are predefined and must be one of the following gold values:
132132
- 2500 gold ($50)
133133

134134
:::note
135-
Actual payments will not be processed until your products are approved. While your app is under development, you can use sandbox payments to [simulate purchases](./payments_test#simulate-purchases).
135+
Actual payments will not be processed until your products are approved. While your app is under development, you can use sandbox payments to [simulate purchases](./payments_test.md#simulate-purchases).
136136
:::
137137

138138
## Design guidelines

docs/introduction/introduction.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ import SnooToolboxClipboard from '@site/versioned_docs/version-0.12/assets/intro
1111
<div style={{ display: 'flex', gap: '2rem', alignItems: 'flex-start', flexWrap: 'wrap' }}>
1212
<div style={{ flex: 1, minWidth: '300px' }}>
1313

14-
Devvit allows you to build interactive games and apps that live on Reddit. Build experiences that can earn up to $167,000 per app with our [Reddit Developer Funds](./earn-money/reddit_developer_funds).
14+
Devvit allows you to build interactive games and apps that live on Reddit. Build experiences that can earn up to $167,000 per app with our [Reddit Developer Funds](../earn-money/reddit_developer_funds.md).
1515

1616
Build community games like [Hot and Cold](https://www.reddit.com/r/hotandcold/), [Sword and Supper](https://www.reddit.com/r/SwordAndSupper/), and [Honk](https://www.reddit.com/r/RedditGames/), or create [custom mod tools](https://www.reddit.com/r/ModSupport/comments/1k6szsj/devvit_apps_for_moderation_a_list/) to empower your community.
1717

18-
**More examples:** [App Showcase](./examples/app-showcase)
18+
**More examples:** [App Showcase](../examples/app-showcase.mdx)
1919

2020
**Questions?** Join [r/devvit](https://www.reddit.com/r/devvit/) or our [Discord](https://discord.gg/Cd43ExtEFS).
2121

0 commit comments

Comments
 (0)