Commit 3468b2e
authored
Synchronize Devvit documentation with current behavior (#160)
<!-- If this pull request closes an issue, please mention the issue
number below -->
Closes #159
## 💸 TL;DR
This PR synchronizes Devvit’s configuration, CLI, launch-screen, and
Redis documentation with the current implementation. It corrects invalid
or outdated examples, documents additional supported configuration
fields, and applies equivalent updates to both the current and versioned
`0.13` documentation. It also centralizes the latest published
documentation version through `versions.json`.
## 📜 Details
Design Doc: Not applicable
Jira: Not applicable
This documentation-only PR:
* Corrects the documented server build path, app-name limit, and default
custom-post height.
* Expands the `devvit.json` reference to cover additional
schema-supported settings, permissions, triggers, assets, payments, and
server options.
* Updates CLI documentation for `init`, `publish`, `logs`, `playtest`,
`upload`, and `view`.
* Removes references to the nonexistent `devvit build` command and
`--here` option.
* Replaces deprecated launch-screen mode-listener examples with the
current focus-based approach.
* Corrects stale Redis links and repairs a malformed transaction
example.
* Removes a duplicated sidebar entry and fixes minor changelog errors.
* Derives `LATEST_DEVVIT_VERSION` from the first entry in
`versions.json` rather than duplicating the version in
`docusaurus.config.ts`.
* Mirrors applicable changes in both `docs/` and
`versioned_docs/version-0.13/`.
This PR does not change Devvit runtime behavior, generated API
references, Blob Storage permission behavior, or Reddit subscription
identity APIs.
## 🧪 Testing Steps / Validation
The following checks were completed against the current repository
snapshot:
1. Applied the patch successfully with:
```bash
git apply --check devvit-docs-patch-1-docs-sync.patch
```
2. Checked the resulting diff for whitespace errors:
```bash
git diff --check
```
3. Parsed all JSON code blocks changed in the configuration guides.
4. Verified that relative documentation links in the changed files
resolve.
5. Checked that Markdown code fences remain balanced.
6. Checked the changed documentation for unexpected control characters.
7. Confirmed that equivalent updates were made to the current and
versioned `0.13` documentation where applicable.
A complete local Docusaurus build was not run because installed
dependencies were not included in the supplied repository snapshot.
Repository CI should run the full documentation build.
> **CI note:** The `Build Documentation` workflow is currently marked
`action_required` because this pull request originates from a fork. A
repository maintainer must approve the workflow before the CI jobs can
run. No CI failures have been reported at this stage.
## ✅ Checks
* [ ] CI tests (if present) are passing
* [x] Adheres to code style for repo
* [x] Contributor License Agreement (CLA) completed if not a Reddit
employee1 parent b0666d2 commit 3468b2e
13 files changed
Lines changed: 514 additions & 173 deletions
File tree
- docs
- capabilities
- devvit-web
- server
- launch_screen_and_entry_points
- guides/tools
- versioned_docs/version-0.13
- capabilities
- devvit-web
- server
- launch_screen_and_entry_points
- guides/tools
- versioned_sidebars
Lines changed: 101 additions & 19 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| |||
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
61 | | - | |
62 | | - | |
63 | | - | |
64 | | - | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
65 | 66 | | |
66 | 67 | | |
67 | 68 | | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
72 | 74 | | |
73 | 75 | | |
74 | 76 | | |
| |||
96 | 98 | | |
97 | 99 | | |
98 | 100 | | |
99 | | - | |
| 101 | + | |
100 | 102 | | |
101 | 103 | | |
102 | 104 | | |
| |||
105 | 107 | | |
106 | 108 | | |
107 | 109 | | |
108 | | - | |
| 110 | + | |
| 111 | + | |
109 | 112 | | |
110 | 113 | | |
111 | 114 | | |
112 | 115 | | |
113 | 116 | | |
114 | 117 | | |
115 | | - | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
116 | 121 | | |
117 | 122 | | |
118 | 123 | | |
| |||
131 | 136 | | |
132 | 137 | | |
133 | 138 | | |
| 139 | + | |
134 | 140 | | |
135 | 141 | | |
136 | 142 | | |
| |||
153 | 159 | | |
154 | 160 | | |
155 | 161 | | |
156 | | - | |
| 162 | + | |
157 | 163 | | |
158 | 164 | | |
| 165 | + | |
| 166 | + | |
159 | 167 | | |
160 | 168 | | |
161 | 169 | | |
| |||
176 | 184 | | |
177 | 185 | | |
178 | 186 | | |
| 187 | + | |
179 | 188 | | |
180 | 189 | | |
181 | 190 | | |
| |||
264 | 273 | | |
265 | 274 | | |
266 | 275 | | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| 334 | + | |
| 335 | + | |
267 | 336 | | |
268 | 337 | | |
269 | 338 | | |
| |||
298 | 367 | | |
299 | 368 | | |
300 | 369 | | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
301 | 382 | | |
302 | 383 | | |
303 | 384 | | |
| |||
316 | 397 | | |
317 | 398 | | |
318 | 399 | | |
319 | | - | |
| 400 | + | |
320 | 401 | | |
321 | 402 | | |
322 | 403 | | |
| |||
333 | 414 | | |
334 | 415 | | |
335 | 416 | | |
336 | | - | |
| 417 | + | |
337 | 418 | | |
338 | 419 | | |
339 | 420 | | |
| |||
356 | 437 | | |
357 | 438 | | |
358 | 439 | | |
359 | | - | |
| 440 | + | |
| 441 | + | |
360 | 442 | | |
361 | 443 | | |
362 | 444 | | |
| |||
Lines changed: 24 additions & 26 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
| 31 | + | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| |||
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
50 | | - | |
51 | | - | |
| 50 | + | |
| 51 | + | |
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | | - | |
| 56 | + | |
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
| |||
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
75 | | - | |
| 75 | + | |
76 | 76 | | |
77 | | - | |
| 77 | + | |
78 | 78 | | |
79 | 79 | | |
80 | | - | |
| 80 | + | |
81 | 81 | | |
82 | 82 | | |
83 | 83 | | |
84 | 84 | | |
85 | 85 | | |
86 | | - | |
87 | | - | |
88 | | - | |
| 86 | + | |
89 | 87 | | |
90 | | - | |
91 | | - | |
| 88 | + | |
| 89 | + | |
92 | 90 | | |
93 | 91 | | |
94 | 92 | | |
| |||
103 | 101 | | |
104 | 102 | | |
105 | 103 | | |
106 | | - | |
107 | | - | |
108 | 104 | | |
109 | 105 | | |
110 | 106 | | |
111 | 107 | | |
112 | 108 | | |
113 | 109 | | |
114 | 110 | | |
115 | | - | |
116 | | - | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
117 | 114 | | |
118 | | - | |
119 | | - | |
| 115 | + | |
| 116 | + | |
120 | 117 | | |
121 | 118 | | |
122 | 119 | | |
123 | 120 | | |
124 | | - | |
125 | | - | |
| 121 | + | |
| 122 | + | |
126 | 123 | | |
127 | 124 | | |
128 | | - | |
| 125 | + | |
129 | 126 | | |
130 | | - | |
| 127 | + | |
| 128 | + | |
131 | 129 | | |
132 | 130 | | |
133 | 131 | | |
134 | | - | |
| 132 | + | |
135 | 133 | | |
136 | 134 | | |
137 | 135 | | |
138 | 136 | | |
139 | | - | |
| 137 | + | |
140 | 138 | | |
141 | | - | |
| 139 | + | |
142 | 140 | | |
143 | 141 | | |
144 | 142 | | |
| |||
0 commit comments