|
1 | | -# Website |
| 1 | + |
2 | 2 |
|
3 | | -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. |
| 3 | +# Reddit's Developer Platform - Devvit Docs |
4 | 4 |
|
5 | | -### Installation |
| 5 | + |
| 6 | +This is the codebase which powers [https://developers.reddit.com/docs](https://developers.reddit.com/docs). |
6 | 7 |
|
7 | | -``` |
8 | | -$ yarn |
9 | | -``` |
| 8 | +## Contribution |
10 | 9 |
|
11 | | -### Local Development |
| 10 | +These docs are intended to be public, and contributions are always welcome. Please raise a PR and we'll approve regularly! |
12 | 11 |
|
13 | | -``` |
14 | | -$ yarn docs:start |
15 | | -``` |
| 12 | +### Contribution License Agreement |
16 | 13 |
|
17 | | -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. |
| 14 | +The first time you submit a pull request (PR) to a Reddit project, [you should complete our CLA](https://docs.google.com/forms/d/e/1FAIpQLScG6Bf3yqS05yWV0pbh5Q60AsaXP2mw35_i7ZA19_7jWNJKsg/viewform). We cannot accept PRs from GitHub users that have not agreed to the CLA. Note that this agreement applies to all open source Reddit projects, and you only need to submit it once. |
18 | 15 |
|
19 | | -Note: |
| 16 | +[Submit your CLA here](https://docs.google.com/forms/d/e/1FAIpQLScG6Bf3yqS05yWV0pbh5Q60AsaXP2mw35_i7ZA19_7jWNJKsg/viewform?usp=sf_link). |
20 | 17 |
|
21 | | -- Changes does not appear on snoodev env can only be tested locally |
| 18 | +## Development |
22 | 19 |
|
23 | | -### Build |
| 20 | +### Installation |
24 | 21 |
|
25 | 22 | ``` |
26 | | -$ yarn docs:build |
| 23 | +$ yarn |
27 | 24 | ``` |
28 | 25 |
|
29 | | -This command generates static content into the `build` directory and can be served using any static contents hosting service. |
30 | | - |
31 | | -### Development lifecycle |
32 | | - |
33 | | -For small doc updates you can skip the deployment phase. |
34 | | - |
35 | | -Once you have your PR approved, make sure to add `[CI SKIP]` to your commit message in GitHub. |
36 | | -More info in [Drone documentation for skipping](https://docs.drone.io/pipeline/skipping/). |
| 26 | +### Local Development |
37 | 27 |
|
38 | | -Now you can merge your PR. |
| 28 | +``` |
| 29 | +$ yarn start |
| 30 | +``` |
39 | 31 |
|
40 | | -Important: do not use `[CI SKIP]` when you `git commit` since your PR will be stuck in pending state. |
41 | | -You only need to add it immediately before merging the PR. |
| 32 | +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. |
0 commit comments