Skip to content

Commit bff0b27

Browse files
committed
update readme
1 parent 386067f commit bff0b27

File tree

1 file changed

+17
-26
lines changed

1 file changed

+17
-26
lines changed

README.md

Lines changed: 17 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,32 @@
1-
# Website
1+
![Devvit Logo](static/img/logo.svg)
22

3-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
3+
# Reddit's Developer Platform - Devvit Docs
44

5-
### Installation
5+
![alt text](https://file%2B.vscode-resource.vscode-cdn.net/Users/ved.petkar/src/devvit-docs/build/assets/images/logo-e945d6d39bba51e0217352e12ec030b7.svg?version%3D1762361573850)
6+
This is the codebase which powers [https://developers.reddit.com/docs](https://developers.reddit.com/docs).
67

7-
```
8-
$ yarn
9-
```
8+
## Contribution
109

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!
1211

13-
```
14-
$ yarn docs:start
15-
```
12+
### Contribution License Agreement
1613

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.
1815

19-
Note:
16+
[Submit your CLA here](https://docs.google.com/forms/d/e/1FAIpQLScG6Bf3yqS05yWV0pbh5Q60AsaXP2mw35_i7ZA19_7jWNJKsg/viewform?usp=sf_link).
2017

21-
- Changes does not appear on snoodev env can only be tested locally
18+
## Development
2219

23-
### Build
20+
### Installation
2421

2522
```
26-
$ yarn docs:build
23+
$ yarn
2724
```
2825

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
3727

38-
Now you can merge your PR.
28+
```
29+
$ yarn start
30+
```
3931

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

Comments
 (0)