Skip to content

Commit f9475d9

Browse files
vdikransamarjianvdikransamarjian
authored
v15 docs audit (#240)
## 💸 TL;DR <!-- What's the three sentence summary of purpose of the PR --> This update aligns *Next and 0.15 documentation* with the release: - Makes migration from `devvit.yaml` to `devvit.json` an explicit requirement before upgrading. - Documents removal of the wiki revision-ID string overload and shows the supported options-object call. - Clarifies that `blocks` and `@devvit/public-api` remain supported but deprecated, with legacy and Devvit Web examples kept separate. - Adds examples for custom expanded-mode titles and navigation between entries while already expanded. The wiki guide is available in both versions, and examples follow the existing docs’ tone. *Why the large diff?* We regenerated the stale development reference from released `@devvit/reddit@0.15.0`, touching *378 generated files*. *318 only update the version label* from `0.15.0-dev` to `0.15.0`. The corpus now includes the changelog and updated guidance. It was flagged to me that corpus was out of date.
1 parent 0b4a8a9 commit f9475d9

398 files changed

Lines changed: 1421 additions & 865 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/api/redditapi/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
**@devvit/reddit v0.15.0-dev**
1+
**@devvit/reddit v0.15.0**
22

33
***
44

5-
# @devvit/reddit v0.15.0-dev
5+
# @devvit/reddit v0.15.0
66

77
## Modules
88

‎docs/api/redditapi/RedditClient/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@devvit/reddit v0.15.0-dev**](../README.md)
1+
[**@devvit/reddit v0.15.0**](../README.md)
22

33
***
44

‎docs/api/redditapi/RedditClient/classes/RedditClient.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@devvit/reddit v0.15.0-dev**](../../README.md)
1+
[**@devvit/reddit v0.15.0**](../../README.md)
22

33
***
44

@@ -288,7 +288,7 @@ Approve a post or comment.
288288

289289
The id of the post (t3_) or comment (t1_) to approve.
290290

291-
`` `t1_${string}` `` | `` `t3_${string}` ``
291+
`` `t3_${string}` `` | `` `t1_${string}` ``
292292

293293
#### Returns
294294

@@ -692,7 +692,7 @@ reason is also shown on the content.
692692

693693
The id of the post (t3_) or comment (t1_) to filter.
694694

695-
`` `t1_${string}` `` | `` `t3_${string}` ``
695+
`` `t3_${string}` `` | `` `t1_${string}` ``
696696

697697
##### options?
698698

@@ -905,7 +905,7 @@ const comments = await reddit.getComments({
905905

906906
### getCommentsAndPostsByUser()
907907

908-
> **getCommentsAndPostsByUser**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
908+
> **getCommentsAndPostsByUser**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
909909
910910
Get a list of posts and comments from a specific user.
911911

@@ -919,7 +919,7 @@ Options for the request
919919

920920
#### Returns
921921

922-
[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
922+
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
923923

924924
A Listing of `Post` and `Comment` objects.
925925

@@ -1144,7 +1144,7 @@ console.log("Posts: ", await listing.all())
11441144

11451145
#### Call Signature
11461146

1147-
> **getEdited**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
1147+
> **getEdited**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
11481148
11491149
Return a listing of things that have been edited recently.
11501150

@@ -1156,7 +1156,7 @@ Return a listing of things that have been edited recently.
11561156

11571157
##### Returns
11581158

1159-
[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
1159+
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
11601160

11611161
##### Example
11621162

@@ -1377,7 +1377,7 @@ console.log("Posts: ", await listing.all())
13771377

13781378
#### Call Signature
13791379

1380-
> **getModQueue**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
1380+
> **getModQueue**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
13811381
13821382
Return a listing of things requiring moderator review, such as reported things and items.
13831383

@@ -1389,7 +1389,7 @@ Return a listing of things requiring moderator review, such as reported things a
13891389

13901390
##### Returns
13911391

1392-
[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
1392+
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
13931393

13941394
##### Example
13951395

@@ -1633,7 +1633,7 @@ console.log("Posts: ", await listing.all())
16331633

16341634
#### Call Signature
16351635

1636-
> **getReports**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
1636+
> **getReports**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
16371637
16381638
Return a listing of things that have been reported.
16391639

@@ -1645,7 +1645,7 @@ Return a listing of things that have been reported.
16451645

16461646
##### Returns
16471647

1648-
[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
1648+
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
16491649

16501650
##### Example
16511651

@@ -1800,7 +1800,7 @@ console.log("Posts: ", await listing.all())
18001800

18011801
#### Call Signature
18021802

1803-
> **getSpam**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
1803+
> **getSpam**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
18041804
18051805
Return a listing of things that have been marked as spam or otherwise removed.
18061806

@@ -1812,7 +1812,7 @@ Return a listing of things that have been marked as spam or otherwise removed.
18121812

18131813
##### Returns
18141814

1815-
[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
1815+
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
18161816

18171817
##### Example
18181818

@@ -1850,7 +1850,7 @@ A Promise that resolves a Subreddit object.
18501850

18511851
#### Deprecated
18521852

1853-
Use [getSubredditInfoById](../../models/functions/getSubredditInfoById.md) instead.
1853+
Use [getSubredditInfoById](#getsubredditinfobyid) instead.
18541854

18551855
#### Example
18561856

@@ -1884,7 +1884,7 @@ A Promise that resolves a Subreddit object.
18841884

18851885
#### Deprecated
18861886

1887-
Use [getSubredditInfoByName](../../models/functions/getSubredditInfoByName.md) instead.
1887+
Use [getSubredditInfoByName](#getsubredditinfobyname) instead.
18881888

18891889
#### Example
18901890

@@ -2151,7 +2151,7 @@ console.log("Posts: ", await listing.all())
21512151

21522152
#### Call Signature
21532153

2154-
> **getUnmoderated**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
2154+
> **getUnmoderated**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
21552155
21562156
Return a listing of things that have yet to be approved/removed by a mod.
21572157

@@ -2163,7 +2163,7 @@ Return a listing of things that have yet to be approved/removed by a mod.
21632163

21642164
##### Returns
21652165

2166-
[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
2166+
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>
21672167

21682168
##### Example
21692169

@@ -2658,7 +2658,7 @@ Remove a post or comment.
26582658

26592659
The id of the post (t3_) or comment (t1_) to remove.
26602660

2661-
`` `t1_${string}` `` | `` `t3_${string}` ``
2661+
`` `t3_${string}` `` | `` `t1_${string}` ``
26622662

26632663
##### isSpam
26642664

@@ -2931,7 +2931,7 @@ The report is sent to the moderators of the subreddit for review.
29312931

29322932
Post or Comment
29332933

2934-
[`Comment`](../../models/classes/Comment.md) | [`Post`](../../models/classes/Post.md)
2934+
[`Post`](../../models/classes/Post.md) | [`Comment`](../../models/classes/Comment.md)
29352935

29362936
##### options
29372937

@@ -3368,7 +3368,7 @@ const post = await reddit.submitCustomPost({
33683368
title: 'My Devvit Post',
33693369
runAs: 'USER',
33703370
userGeneratedContent: {
3371-
text: "hello there",
3371+
text: "hello there",
33723372
imageUrls: ["https://styles.redditmedia.com/t5_5wa5ww/styles/communityIcon_wyopomb2xb0a1.png", "https://styles.redditmedia.com/t5_49fkib/styles/bannerBackgroundImage_5a4axis7cku61.png"]
33733373
},
33743374
subredditName: context.subredditName,

‎docs/api/redditapi/RedditClient/type-aliases/CustomPostStyles.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@devvit/reddit v0.15.0-dev**](../../README.md)
1+
[**@devvit/reddit v0.15.0**](../../README.md)
22

33
***
44

‎docs/api/redditapi/RedditClient/type-aliases/InviteModeratorOptions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@devvit/reddit v0.15.0-dev**](../../README.md)
1+
[**@devvit/reddit v0.15.0**](../../README.md)
22

33
***
44

‎docs/api/redditapi/RedditClient/type-aliases/MuteUserOptions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@devvit/reddit v0.15.0-dev**](../../README.md)
1+
[**@devvit/reddit v0.15.0**](../../README.md)
22

33
***
44

‎docs/api/redditapi/models/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@devvit/reddit v0.15.0-dev**](../README.md)
1+
[**@devvit/reddit v0.15.0**](../README.md)
22

33
***
44

‎docs/api/redditapi/models/classes/AuthorFlairSettings.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@devvit/reddit v0.15.0-dev**](../../README.md)
1+
[**@devvit/reddit v0.15.0**](../../README.md)
22

33
***
44

‎docs/api/redditapi/models/classes/ButtonWidget.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@devvit/reddit v0.15.0-dev**](../../README.md)
1+
[**@devvit/reddit v0.15.0**](../../README.md)
22

33
***
44

@@ -152,11 +152,11 @@
152152

153153
### toJSON()
154154

155-
> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"name"` \| `"id"` \| `"subredditName"`\> & `Pick`\<`ButtonWidget`, `"description"` \| `"styles"` \| `"buttons"`\>
155+
> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`ButtonWidget`, `"description"` \| `"styles"` \| `"buttons"`\>
156156
157157
#### Returns
158158

159-
`Pick`\<[`Widget`](Widget.md), `"name"` \| `"id"` \| `"subredditName"`\> & `Pick`\<`ButtonWidget`, `"description"` \| `"styles"` \| `"buttons"`\>
159+
`Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`ButtonWidget`, `"description"` \| `"styles"` \| `"buttons"`\>
160160

161161
#### Overrides
162162

‎docs/api/redditapi/models/classes/CalendarWidget.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@devvit/reddit v0.15.0-dev**](../../README.md)
1+
[**@devvit/reddit v0.15.0**](../../README.md)
22

33
***
44

@@ -152,11 +152,11 @@
152152

153153
### toJSON()
154154

155-
> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"name"` \| `"id"` \| `"subredditName"`\> & `Pick`\<`CalendarWidget`, `"styles"` \| `"googleCalendarId"` \| `"configuration"`\>
155+
> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`CalendarWidget`, `"googleCalendarId"` \| `"configuration"` \| `"styles"`\>
156156
157157
#### Returns
158158

159-
`Pick`\<[`Widget`](Widget.md), `"name"` \| `"id"` \| `"subredditName"`\> & `Pick`\<`CalendarWidget`, `"styles"` \| `"googleCalendarId"` \| `"configuration"`\>
159+
`Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`CalendarWidget`, `"googleCalendarId"` \| `"configuration"` \| `"styles"`\>
160160

161161
#### Overrides
162162

0 commit comments

Comments
 (0)