You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
update readme and fix commands and links in CLI docs (#46)
1. Updated README to reflect process of updating both versioned and
unversioned docs
2. fixed CLI error in publishing docs
3. Added links and small updates to publishing doc
Copy file name to clipboardExpand all lines: README.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,10 @@ The first time you submit a pull request (PR) to a Reddit project, [you should c
25
25
26
26
[Submit your CLA here](https://docs.google.com/forms/d/e/1FAIpQLScG6Bf3yqS05yWV0pbh5Q60AsaXP2mw35_i7ZA19_7jWNJKsg/viewform?usp=sf_link).
27
27
28
+
## Make sure to update both versioned and unversioned docs
29
+
30
+
All changes made to the Devvit docs but be made to both the latest [versioned instance](https://github.com/reddit/devvit-docs/tree/main/versioned_docs) of the docs as well as the [unversioned instance](https://github.com/reddit/devvit-docs/tree/main/docs) of those docs. While we know this isn't ideal, it is essential for ensuring changes aren't overwritten as new versions of Devvit are released.
Copy file name to clipboardExpand all lines: docs/guides/launch/launch-guide.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,12 +23,12 @@ Before submitting your app for review, be sure to:
23
23
We also recommend getting feedback from the community:
24
24
25
25
-**All apps:**
26
-
-[Cross-post](https://support.reddithelp.com/hc/en-us/articles/4835584113684-What-is-Crossposting) your post to r/Devvit using the **Feedback Friday** flair.
27
-
- Share your app in the **#sharing** channel in the Reddit Devs Discord.
26
+
-[Cross-post](https://support.reddithelp.com/hc/en-us/articles/4835584113684-What-is-Crossposting) your post to [r/Devvit](https://reddit.com/r/Devvit) using the **Feedback Friday** flair.
27
+
- Share your app in the **#ideas-and-feedback** channel in the Reddit Devs Discord.
28
28
-**Games:**
29
-
- Cross-post gameplay posts to r/GamesOnReddit with the **Feedback** flair.
29
+
- Cross-post gameplay posts to [r/GamesOnReddit](https://reddit.com/r/GamesOnReddit) with the **Feedback** flair.
30
30
-**Mod Apps:**
31
-
- Share your app in the **#mod-discussion** Discord channel for moderator-specific feedback.
31
+
- Share your app in the **#mod-chat** Discord channel for moderator-specific feedback.
32
32
33
33
If your app is a **game**, ensure the experience:
34
34
@@ -57,7 +57,7 @@ You will receive email confirmation when your app is approved. If we need more i
57
57
Because you must run `npx devvit publish` for **every version** you want to launch, we recommend batching updates into weekly (or less frequent) releases.
58
58
59
59
Review times vary. We aim to review most apps — especially version updates — within **1–2 business days**. New apps, apps with policy ambiguity, or apps using higher-risk features (e.g., payments, fetch) may require more time.
60
-
If you haven’t heard from us after a week, please reach out in Discord or via r/Devvit Modmail.
60
+
If you haven’t heard from us after a week, please reach out in Discord or via [r/Devvit Modmail](https://www.reddit.com/message/compose/?to=r/Devvit).
61
61
62
62
Ensuring your app complies with all [Devvit Rules](https://developers.reddit.com/docs/devvit_rules) will streamline review.
63
63
@@ -77,7 +77,7 @@ Publicly listed apps must include a detailed `README.md` with:
77
77
78
78
To list your app:
79
79
80
-
1. Run `npx devvit publish --listed`
80
+
1. Run `npx devvit publish --public`
81
81
2. Once approved, it will appear in the Apps Directory for any community to install.
82
82
83
83
We do not recommend listing apps built for a single subreddit, as this may confuse moderators and clutter the directory.
Copy file name to clipboardExpand all lines: versioned_docs/version-0.12/guides/launch/launch-guide.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,12 +23,12 @@ Before submitting your app for review, be sure to:
23
23
We also recommend getting feedback from the community:
24
24
25
25
-**All apps:**
26
-
-[Cross-post](https://support.reddithelp.com/hc/en-us/articles/4835584113684-What-is-Crossposting) your post to r/Devvit using the **Feedback Friday** flair.
27
-
- Share your app in the **#sharing** channel in the Reddit Devs Discord.
26
+
-[Cross-post](https://support.reddithelp.com/hc/en-us/articles/4835584113684-What-is-Crossposting) your post to [r/Devvit](https://reddit.com/r/Devvit) using the **Feedback Friday** flair.
27
+
- Share your app in the **#ideas-and-feedback** channel in the Reddit Devs Discord.
28
28
-**Games:**
29
-
- Cross-post gameplay posts to r/GamesOnReddit with the **Feedback** flair.
29
+
- Cross-post gameplay posts to [r/GamesOnReddit](https://reddit.com/r/GamesOnReddit) with the **Feedback** flair.
30
30
-**Mod Apps:**
31
-
- Share your app in the **#mod-discussion** Discord channel for moderator-specific feedback.
31
+
- Share your app in the **#mod-chat** Discord channel for moderator-specific feedback.
32
32
33
33
If your app is a **game**, ensure the experience:
34
34
@@ -57,7 +57,7 @@ You will receive email confirmation when your app is approved. If we need more i
57
57
Because you must run `npx devvit publish` for **every version** you want to launch, we recommend batching updates into weekly (or less frequent) releases.
58
58
59
59
Review times vary. We aim to review most apps — especially version updates — within **1–2 business days**. New apps, apps with policy ambiguity, or apps using higher-risk features (e.g., payments, fetch) may require more time.
60
-
If you haven’t heard from us after a week, please reach out in Discord or via r/Devvit Modmail.
60
+
If you haven’t heard from us after a week, please reach out in Discord or via [r/Devvit Modmail](https://www.reddit.com/message/compose/?to=r/Devvit).
61
61
62
62
Ensuring your app complies with all [Devvit Rules](https://developers.reddit.com/docs/devvit_rules) will streamline review.
63
63
@@ -77,7 +77,7 @@ Publicly listed apps must include a detailed `README.md` with:
77
77
78
78
To list your app:
79
79
80
-
1. Run `npx devvit publish --listed`
80
+
1. Run `npx devvit publish --public`
81
81
2. Once approved, it will appear in the Apps Directory for any community to install.
82
82
83
83
We do not recommend listing apps built for a single subreddit, as this may confuse moderators and clutter the directory.
0 commit comments