Skip to content

Commit eccea59

Browse files
authored
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
1 parent 0330e73 commit eccea59

3 files changed

Lines changed: 16 additions & 12 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ The first time you submit a pull request (PR) to a Reddit project, [you should c
2525

2626
[Submit your CLA here](https://docs.google.com/forms/d/e/1FAIpQLScG6Bf3yqS05yWV0pbh5Q60AsaXP2mw35_i7ZA19_7jWNJKsg/viewform?usp=sf_link).
2727

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.
31+
2832
## Development
2933

3034
### Installation

docs/guides/launch/launch-guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ Before submitting your app for review, be sure to:
2323
We also recommend getting feedback from the community:
2424

2525
- **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.
2828
- **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.
3030
- **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.
3232

3333
If your app is a **game**, ensure the experience:
3434

@@ -57,7 +57,7 @@ You will receive email confirmation when your app is approved. If we need more i
5757
Because you must run `npx devvit publish` for **every version** you want to launch, we recommend batching updates into weekly (or less frequent) releases.
5858

5959
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).
6161

6262
Ensuring your app complies with all [Devvit Rules](https://developers.reddit.com/docs/devvit_rules) will streamline review.
6363

@@ -77,7 +77,7 @@ Publicly listed apps must include a detailed `README.md` with:
7777

7878
To list your app:
7979

80-
1. Run `npx devvit publish --listed`
80+
1. Run `npx devvit publish --public`
8181
2. Once approved, it will appear in the Apps Directory for any community to install.
8282

8383
We do not recommend listing apps built for a single subreddit, as this may confuse moderators and clutter the directory.

versioned_docs/version-0.12/guides/launch/launch-guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ Before submitting your app for review, be sure to:
2323
We also recommend getting feedback from the community:
2424

2525
- **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.
2828
- **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.
3030
- **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.
3232

3333
If your app is a **game**, ensure the experience:
3434

@@ -57,7 +57,7 @@ You will receive email confirmation when your app is approved. If we need more i
5757
Because you must run `npx devvit publish` for **every version** you want to launch, we recommend batching updates into weekly (or less frequent) releases.
5858

5959
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).
6161

6262
Ensuring your app complies with all [Devvit Rules](https://developers.reddit.com/docs/devvit_rules) will streamline review.
6363

@@ -77,7 +77,7 @@ Publicly listed apps must include a detailed `README.md` with:
7777

7878
To list your app:
7979

80-
1. Run `npx devvit publish --listed`
80+
1. Run `npx devvit publish --public`
8181
2. Once approved, it will appear in the Apps Directory for any community to install.
8282

8383
We do not recommend listing apps built for a single subreddit, as this may confuse moderators and clutter the directory.

0 commit comments

Comments
 (0)